# Account

An Account as represented in the account ecosystem.

## Example Usage

```typescript
import { Account } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: Account = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                               | Example                                                                                                                                                                                                                                                                                                                                                                                                   |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `acceptsIssuerDirectCommunication`                                                                                                                                                                                                                                                                                                                                                                        | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates if the issuer of a security held by the account is permitted to communicate directly with the shareholder versus through the brokerage firm; This can include sending proxy statements, annual reports, and other important information directly to the shareholder's address on file with the brokerage firm. By default, this is set to `false`.                                              | false                                                                                                                                                                                                                                                                                                                                                                                                     |
| `accountGroupId`                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | An Account Group is a way of segmenting accounts within a Correspondent; It is up to the client to define what these groups are and AFS Operations is responsible for configuring them; If the client requests additional groups/codes, they can be added; Examples of Account Groups could hypothetically include HNW (High Net Worth), GOLD (Gold Status Customer), and NWC (Northwest Branch Customer) | 01ARZ3NDEKTSV4RRFFQ69G5FAV                                                                                                                                                                                                                                                                                                                                                                                |
| `accountId`                                                                                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A globally unique identifier referencing a single account; This is the main identifier for an account used for machine-to-machine interactions                                                                                                                                                                                                                                                            | 01HC3MAQ4DR9QN1V8MJ4CN1HMK                                                                                                                                                                                                                                                                                                                                                                                |
| `accountNumber`                                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A "unique" identifier referencing this single account This should be the human readable identifier for the account used for display                                                                                                                                                                                                                                                                       | N6D8ZJP                                                                                                                                                                                                                                                                                                                                                                                                   |
| `activeRestrictions`                                                                                                                                                                                                                                                                                                                                                                                      | *string*[]                                                                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The list of restrictions currently impacting a given account; Restrictions suspend one or more entitlements dependent on their mapping                                                                                                                                                                                                                                                                    | [<br/>"AML_PARTIES_PENDING_INITIAL_KYC"<br/>]                                                                                                                                                                                                                                                                                                                                                             |
| `advised`                                                                                                                                                                                                                                                                                                                                                                                                 | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A boolean to indicate if an account is advised. By default, this is set to `false`.                                                                                                                                                                                                                                                                                                                       | true                                                                                                                                                                                                                                                                                                                                                                                                      |
| `agreements`                                                                                                                                                                                                                                                                                                                                                                                              | [components.Agreement](../../models/components/agreement.md)[]                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The collection of legal agreements belonging to a given account                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `catAccountHolderType`                                                                                                                                                                                                                                                                                                                                                                                    | [components.AccountCatAccountHolderType](../../models/components/accountcataccountholdertype.md)                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The FINRA CAT classification for the Account Holder; Is set automatically based on attributes of the owners and account type                                                                                                                                                                                                                                                                              | I_INDIVIDUAL                                                                                                                                                                                                                                                                                                                                                                                              |
| `catReporterInformation`                                                                                                                                                                                                                                                                                                                                                                                  | [components.CatReporterInformation](../../models/components/catreporterinformation.md)                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The CAT reporter information for the account                                                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `cftcOwnerType`                                                                                                                                                                                                                                                                                                                                                                                           | [components.CftcOwnerType](../../models/components/cftcownertype.md)                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates the CFTC (Commodity Futures Trading Commission) owner type of the account. This enum only applies to accounts regulated by the CFTC                                                                                                                                                                                                                                                             | CUSTOMER                                                                                                                                                                                                                                                                                                                                                                                                  |
| `clientAccountId`                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | An external identifier for the account. This identifier does not have internal uniqueness constraints.                                                                                                                                                                                                                                                                                                    | 12345678                                                                                                                                                                                                                                                                                                                                                                                                  |
| `closeTime`                                                                                                                                                                                                                                                                                                                                                                                               | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The time the account was closed; If the account is not closed, this is null                                                                                                                                                                                                                                                                                                                               | 2023-10-13T15:30:25.457378Z                                                                                                                                                                                                                                                                                                                                                                               |
| `correspondentId`                                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A unique identifier referencing a Correspondent; A Client may have several operating Correspondents within its purview.                                                                                                                                                                                                                                                                                   | 01HPMZZM6RKMVZA1JQ63RQKJRP                                                                                                                                                                                                                                                                                                                                                                                |
| `createTime`                                                                                                                                                                                                                                                                                                                                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The time the initial account record was created; May differ from the `open_time` timestamp which depends on when all required data was provided to the system                                                                                                                                                                                                                                             | 2023-10-13T15:28:17.262732Z                                                                                                                                                                                                                                                                                                                                                                               |
| `domicile`                                                                                                                                                                                                                                                                                                                                                                                                | [components.Domicile](../../models/components/domicile.md)                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates if the account is `DOMESTIC` or `FOREIGN`                                                                                                                                                                                                                                                                                                                                                       | FOREIGN                                                                                                                                                                                                                                                                                                                                                                                                   |
| `enrollments`                                                                                                                                                                                                                                                                                                                                                                                             | [components.Enrollment](../../models/components/enrollment.md)[]                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A list of enrollments (or "features") on an account; May consist of both active an inactive enrollments                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `fdid`                                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Apex requires a Firm-Designated ID (FDID) for Consolidated Audit Trail (CAT) reporting and uses it as a unique identifier for each trading account; The identifier cannot be the same as the accountID; Apex automatically assigns this ID.                                                                                                                                                               | JY3E1OC2J3IA                                                                                                                                                                                                                                                                                                                                                                                              |
| `finraCoaCode`                                                                                                                                                                                                                                                                                                                                                                                            | [components.FinraCoaCode](../../models/components/finracoacode.md)                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The FINRA COA code associated with the account                                                                                                                                                                                                                                                                                                                                                            | CAT_08_CUSTOMER                                                                                                                                                                                                                                                                                                                                                                                           |
| `fundingType`                                                                                                                                                                                                                                                                                                                                                                                             | [components.FundingType](../../models/components/fundingtype.md)                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Describes if the account is cash-only or has access to a form of margin                                                                                                                                                                                                                                                                                                                                   | CASH                                                                                                                                                                                                                                                                                                                                                                                                      |
| ~~`identifiers`~~                                                                                                                                                                                                                                                                                                                                                                                         | [components.Identifier](../../models/components/identifier.md)[]                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>A list of identifiers associated with the account                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `interestedParties`                                                                                                                                                                                                                                                                                                                                                                                       | [components.InterestedParty](../../models/components/interestedparty.md)[]                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A list of natural persons indicated to receive selected account documents such as account statements                                                                                                                                                                                                                                                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `investmentProfile`                                                                                                                                                                                                                                                                                                                                                                                       | [components.InvestmentProfile](../../models/components/investmentprofile.md)                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The account's goals and customer's financial profile; Used to assess customer fitness and is required by FINRA                                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `managed`                                                                                                                                                                                                                                                                                                                                                                                                 | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A boolean to indicate if an account is managed. By default, this is set to `false`.                                                                                                                                                                                                                                                                                                                       | true                                                                                                                                                                                                                                                                                                                                                                                                      |
| `marginGroupId`                                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | An identifier generated for all non-cash accounts; Uses a combination of account type and owner information to tie accounts together in order to perform margin calculations                                                                                                                                                                                                                              | d6a89a63-1066-4305-8df6-62a8294470d9                                                                                                                                                                                                                                                                                                                                                                      |
| `name`                                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The name field Format: accounts/{account}                                                                                                                                                                                                                                                                                                                                                                 | accounts/01HC3MAQ4DR9QN1V8MJ4CN1HMK                                                                                                                                                                                                                                                                                                                                                                       |
| `openTime`                                                                                                                                                                                                                                                                                                                                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The time the account was activated; Differs from `create_time` which is when the initial account record was created                                                                                                                                                                                                                                                                                       | 2023-10-13T15:28:25.457378Z                                                                                                                                                                                                                                                                                                                                                                               |
| `originatingAccountId`                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The previous account ID associated with the account; Must be unique                                                                                                                                                                                                                                                                                                                                       | 12345678                                                                                                                                                                                                                                                                                                                                                                                                  |
| `ownershipType`                                                                                                                                                                                                                                                                                                                                                                                           | [components.OwnershipType](../../models/components/ownershiptype.md)                                                                                                                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A roll-up account classification based on the `registration_type`; Indicates what owns the account and/or if it is a special type (e.g., Joint, Estate, Retirement, etc.); Used primarily for reporting and high-level type identification                                                                                                                                                                | INDIVIDUAL                                                                                                                                                                                                                                                                                                                                                                                                |
| `parties`                                                                                                                                                                                                                                                                                                                                                                                                 | [components.Party](../../models/components/party.md)[]                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Parties associated with the account (e.g. custodian).                                                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `patternDayTrader`                                                                                                                                                                                                                                                                                                                                                                                        | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates if the customer is a PDT; This is set if the account executes four or more day trades (buy and sell the same security intraday) within a period of five business days. By default, this is set to `false`.                                                                                                                                                                                      | false                                                                                                                                                                                                                                                                                                                                                                                                     |
| `primaryRegisteredRepId`                                                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The primary registered representative for the account                                                                                                                                                                                                                                                                                                                                                     | 01HB7N66WW02WG3B6B9W29K0HF                                                                                                                                                                                                                                                                                                                                                                                |
| `registrationType`                                                                                                                                                                                                                                                                                                                                                                                        | [components.RegistrationType](../../models/components/registrationtype.md)                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The registration of the account (e.g. Individual, Joint, IRA, etc.)                                                                                                                                                                                                                                                                                                                                       | INDIVIDUAL_REGISTRATION                                                                                                                                                                                                                                                                                                                                                                                   |
| `reserveClass`                                                                                                                                                                                                                                                                                                                                                                                            | [components.ReserveClass](../../models/components/reserveclass.md)                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The Reserve Class associated with the account                                                                                                                                                                                                                                                                                                                                                             | CUSTOMER                                                                                                                                                                                                                                                                                                                                                                                                  |
| `state`                                                                                                                                                                                                                                                                                                                                                                                                   | [components.AccountState](../../models/components/accountstate.md)                                                                                                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Indicates if the account is `OPEN`, `PENDING`, or `CLOSED`                                                                                                                                                                                                                                                                                                                                                | OPEN                                                                                                                                                                                                                                                                                                                                                                                                      |
| `taxProfile`                                                                                                                                                                                                                                                                                                                                                                                              | [components.AccountTaxProfile](../../models/components/accounttaxprofile.md)                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | Tax-related attributes for the account; A tax profile with taxpayer attributes is located on the `legal_natural_person` or `legal_entity` objects elsewhere on the account record                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `title`                                                                                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | The title of the account.                                                                                                                                                                                                                                                                                                                                                                                 | Firstname Lastname                                                                                                                                                                                                                                                                                                                                                                                        |
| `trustedContacts`                                                                                                                                                                                                                                                                                                                                                                                         | [components.TrustedContact](../../models/components/trustedcontact.md)[]                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A list of persons designated to verify the well being of the account holder.                                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                           |
| `wrapFeeBilled`                                                                                                                                                                                                                                                                                                                                                                                           | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                        | A boolean to indicate if an account is a wrap brokerage account. By default, this is set to `false`.                                                                                                                                                                                                                                                                                                      | true                                                                                                                                                                                                                                                                                                                                                                                                      |