> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Account Fields

> Account fields for the MDX On Demand API.

## Account Fields

| Field Name                      | Data Type        | Description                                                                                                                               |
| ------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `account_number`                | `String`         | The account number. In some cases this may be a partial or masked value.                                                                  |
| `apr`                           | `Decimal (10,6)` | Annual percentage rate.                                                                                                                   |
| `apy`                           | `Decimal (10,6)` | Annual percentage yield.                                                                                                                  |
| `available_balance`             | `Decimal (14,2)` | The balance available for use in asset accounts like checking and savings. Pending transactions are typically included.                   |
| `available_credit`              | `Decimal (14,2)` | The amount of credit available for liability accounts like credit cards and lines of credit. Pending transactions are typically included. |
| `balance`                       | `Decimal (14,2)` | The current balance of the account. Pending transactions are typically not included.                                                      |
| `cash_advance_apr`              | `Decimal (10,6)` | APR values for cash advances.                                                                                                             |
| `cash_surrender_value`          | `Decimal (10,2)` | Amount paid if the policy is terminated before maturity or insured event occurs.                                                          |
| `credit_limit`                  | `Decimal (14,2)` | The credit limit on the account.                                                                                                          |
| `currency_code`                 | `String`         | Three-character ISO 4217 currency code.                                                                                                   |
| `daily_deposit_limit_current`   | `Decimal (10,2)` | Current daily deposit limit.                                                                                                              |
| `daily_deposit_limit_total`     | `Decimal (10,2)` | Total daily deposit limit.                                                                                                                |
| `day_payment_is_due`            | `Integer`        | Day of the month payment is due.                                                                                                          |
| `death_benefit`                 | `Decimal (10,0)` | Amount paid to beneficiary upon death.                                                                                                    |
| `guid`                          | `String`         | Unique MX-defined account identifier.                                                                                                     |
| `federal_insurance_status`      | `String`         | Indicates whether account is insured by FDIC or NCUA.                                                                                     |
| `has_monthly_transfer_limit`    | `Boolean`        | Indicates if account limits transfers monthly.                                                                                            |
| `hold_total`                    | `Decimal (14,2)` | Total monetary amount of holds on the account.                                                                                            |
| `id`                            | `String (1024)`  | Unique partner-provided identifier for the account.                                                                                       |
| `insured_name`                  | `String`         | Name of insured individual.                                                                                                               |
| `interest_paid_previous_year`   | `Decimal (10,2)` | Interest paid during previous year.                                                                                                       |
| `interest_paid_ytd`             | `Decimal (10,2)` | Interest paid year to date.                                                                                                               |
| `interest_rate`                 | `Decimal (10,2)` | Interest rate percentage.                                                                                                                 |
| `is_closed`                     | `Boolean`        | Indicates whether the account is closed.                                                                                                  |
| `is_hidden`                     | `Boolean`        | Indicates whether the account is hidden.                                                                                                  |
| `last_payment`                  | `Decimal (10,2)` | Amount of last payment.                                                                                                                   |
| `last_payment_at`               | `Integer`        | Date and time of last payment.                                                                                                            |
| `last_payment_on`               | `String`         | Date of last payment.                                                                                                                     |
| `loan_amount`                   | `Decimal (14,2)` | Original loan amount.                                                                                                                     |
| `matures_at`                    | `Integer`        | Date and time account matures.                                                                                                            |
| `matures_on`                    | `String`         | Maturity date of account.                                                                                                                 |
| `member_guid`                   | `String`         | MX-defined member identifier associated with account.                                                                                     |
| `member_id`                     | `String`         | Partner-provided member identifier.                                                                                                       |
| `metadata`                      | `String`         | Additional partner-defined account metadata.                                                                                              |
| `minimum_balance`               | `Decimal (14,2)` | Minimum required balance.                                                                                                                 |
| `monthly_deposit_limit_current` | `Decimal (10,2)` | Current monthly deposit limit.                                                                                                            |
| `monthly_deposit_limit_total`   | `Decimal (10,2)` | Total monthly deposit limit.                                                                                                              |
| `minimum_payment`               | `Decimal (10,2)` | Minimum payment for current cycle.                                                                                                        |
| `monthly_transfer_count`        | `Decimal`        | Number of limited transfers this month.                                                                                                   |
| `name`                          | `String (1024)`  | Human-readable account name visible to users.                                                                                             |
| `next_payment`                  | `Decimal (10,2)` | Amount due for next payment.                                                                                                              |
| `nickname`                      | `String (1024)`  | User-provided nickname for the account.                                                                                                   |
| `original_balance`              | `Decimal (14,2)` | Original balance of account.                                                                                                              |
| `past_due_amount`               | `Decimal (10,2)` | Delinquent payment amount.                                                                                                                |
| `past_due_at`                   | `Integer`        | Date and time payment becomes delinquent.                                                                                                 |
| `past_due_on`                   | `String`         | Date payment becomes delinquent.                                                                                                          |
| `payment_due_at`                | `Integer`        | Date and time payment is due.                                                                                                             |
| `payment_due_on`                | `String`         | Payment due date.                                                                                                                         |
| `payoff_balance`                | `Decimal (14,2)` | Payoff balance.                                                                                                                           |
| `pay_out_amount`                | `Decimal (10,2)` | Insurance payout amount.                                                                                                                  |
| `pending_balance`               | `Decimal (14,2)` | Balance after pending transactions.                                                                                                       |
| `pending_transactions_total`    | `Decimal (14,2)` | Total amount of pending transactions.                                                                                                     |
| `premium_amount`                | `Decimal (10,2)` | Insurance premium amount.                                                                                                                 |
| `principal_balance`             | `Decimal (10,2)` | Principal balance for loan accounts.                                                                                                      |
| `routing_number`                | `String`         | Routing number for account.                                                                                                               |
| `started_at`                    | `Integer`        | Date and time loan or liability account started.                                                                                          |
| `started_on`                    | `String`         | Date loan or liability account started.                                                                                                   |
| `statement_balance`             | `Decimal (14,2)` | Balance at end of last statement period.                                                                                                  |
| `statement_closed_on`           | `String`         | Closing date of last billing cycle.                                                                                                       |
| `statement_late_charges`        | `Decimal (10,2)` | Late charges applied during statement period.                                                                                             |
| `subtype`                       | `String`         | Additional account subtype information.                                                                                                   |
| `type`                          | `String`         | Specific account type.                                                                                                                    |
| `user_guid`                     | `String`         | MX-defined user identifier associated with account.                                                                                       |
| `user_id`                       | `String`         | Partner-provided user identifier.                                                                                                         |

## Account Types

| Type             | Supertype   | Notes                               |
| ---------------- | ----------- | ----------------------------------- |
| `ANY`            | `UNKNOWN`   | Default if invalid or not provided. |
| `CHECKING`       | `ASSET`     |                                     |
| `SAVINGS`        | `ASSET`     |                                     |
| `LOAN`           | `LIABILITY` |                                     |
| `CREDIT_CARD`    | `LIABILITY` |                                     |
| `INVESTMENT`     | `ASSET`     |                                     |
| `LINE_OF_CREDIT` | `LIABILITY` |                                     |
| `MORTGAGE`       | `LIABILITY` |                                     |
| `PROPERTY`       | `ASSET`     |                                     |
| `CASH`           | `ASSET`     |                                     |
| `INSURANCE`      | `LIABILITY` | Optional type.                      |
| `PREPAID`        | `LIABILITY` | Optional type.                      |

## Account Subtypes

| Subtype                     | Parent Type  |
| --------------------------- | ------------ |
| `MONEY_MARKET`              | `SAVINGS`    |
| `CERTIFICATE_OF_DEPOSIT`    | `SAVINGS`    |
| `AUTO`                      | `LOAN`       |
| `STUDENT`                   | `LOAN`       |
| `SMALL_BUSINESS`            | `LOAN`       |
| `PERSONAL`                  | `LOAN`       |
| `HOME_EQUITY`               | `LOAN`       |
| `PLAN_401_K`                | `INVESTMENT` |
| `IRA`                       | `INVESTMENT` |
| `ROTH_IRA`                  | `INVESTMENT` |
| `BROKERAGE`                 | `INVESTMENT` |
| `PENSION`                   | `INVESTMENT` |
| `BOAT`                      | `LOAN`       |
| `RV`                        | `LOAN`       |
| `HELOC`                     | `LOAN`       |
| `FIXED_ANNUITY`             | `INVESTMENT` |
| `VARIABLE_ANNUITY`          | `INVESTMENT` |
| `VEHICLE_INSURANCE`         | `INSURANCE`  |
| `HEALTH`                    | `INSURANCE`  |
| `TERM_LIFE`                 | `INSURANCE`  |
| `WHOLE_LIFE`                | `INSURANCE`  |
| `HSA`                       | `INVESTMENT` |
| `CASH_MANAGEMENT_ACCOUNT`   | `INVESTMENT` |
| `CORPORATE_ACCOUNT`         | `INVESTMENT` |
| `LIMITED_LIABILITY_ACCOUNT` | `INVESTMENT` |
| `HSA_SAVINGS`               | `INVESTMENT` |
| `HSA_CHECKING`              | `INVESTMENT` |

## Account Supertypes

| Supertype   | Notes                                                                 |
| ----------- | --------------------------------------------------------------------- |
| `UNKNOWN`   |                                                                       |
| `ASSET`     | Accounts that are generally considered to be an asset to the user.    |
| `LIABILITY` | Accounts that are generally considered to be a liability to the user. |
