Data elements FDX v4
Please note!
The FDX v4 data element descriptions follow the FDX v4.1 schema. However, each data provider may define individual data elements differently. For any differences or notable exceptions, please see the data provider documentation tabs in the Data Recipient Hub.
Account
Extends and inherits all fields from AccountDescriptor.
| Field | Type | Description |
|---|---|---|
| parentAccountId | Identifier | Long-term persistent identity of the parent account. This is used to group accounts. |
| lineOfBusiness | string | The line of business, such as consumer, consumer joint, small business, corporate, etc. |
| routingTransitNumber | string | Routing transit number (RTN) associated with account number at data provider. |
| balanceType | BalanceType | ASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance) |
| interestRate | Number | Interest Rate of Account |
| interestRateType | InterestRateType | FIXED or VARIABLE |
| interestRateAsOf | Timestamp | Date of account's interest rate. ISO 8601 date time with milliseconds in UTC time zone. |
| priorInterestRate | Number | Previous Interest Rate of Account |
| transferIn | Boolean | Account is eligible for incoming transfers |
| transferOut | Boolean | Account is eligible for outgoing transfers |
| micrNumber | String64 | MICR Number |
| lastActivityDate | Timestamp | Date that last transaction occurred on account. ISO 8601 date time with milliseconds in UTC time zone. |
| transactionsIncluded | Boolean | Default is false. If present and true, a call to retrieve transactions will not return any further details about this account. This is an optimization that allows for returning transactions and account details in a single call. |
| currency | Currency |
AccountDescriptor
Minimal information about the account for use in lightweight arrays.
| Field | Type | Description |
|---|---|---|
| accountId | Identifier | Long-term persistent identity of the account. Not an account number. This identity must be unique to the data provider. |
| error | Error | Present if an error was encountered while retrieving this account |
| accountType | AccountType | Enum: 401A, 401K, 403B, 529, AUTOLOAN, CD, CHARGE, CHECKING, COMMERCIALLINEOFCREDIT, COMMERCIALLOAN, COVERDELL, CREDITCARD, ESCROW, ESOP, GUARDIAN, HOMEEQUITYLOAN, HOMELINEOFCREDIT, INSTITUTIONALTRUST, INSTALLMENT, IRA, KEOGH, LINEOFCREDIT, LOAN, MILITARYLOAN, MONEYMARKET, MORTGAGE, PERSONALLOAN, ROLLOVER, ROTH, SARSEP, SAVINGS, SMBLOAN, STUDENTLOAN, TAXABLE, TDA, TRUST, UGMA, UTMA, ANNUITY |
| accountNumber | string | Full account number. |
| accountNumberDisplay | string | Account display number for the end-user's handle at data provider. This is to be displayed by the data recipient. |
| productName | string | Marketed product name for this account. Used in UIs to assist in account selection |
| nickName | string | Name given by the user. Used in UIs to assist in account selection |
| status | AccountStatus | Enum: OPEN, CLOSED, PENDINGOPEN, PENDINGCLOSE, DELINQUENT, PAID, NEGATIVECURRENTBALANCE |
| description | string | Description of account |
Accounts
An optionally paginated array of accounts.
| Field | Type | Description |
|---|---|---|
| Total | int | Total number of results in this collection across all pages |
AnnuityAccount
| Field | Type | Description |
|---|---|---|
| annuityProductType | AnnuityProductType | DERERRED, IMMEDIATE, CURRENCY, SHARES |
| annuityValueBasis | AnnuityValueBasis | FIXED, VARIABLE |
| paymentAmount | Number | Amount of the recurring payment. |
| paymentFrequency | PaymentFrequency | ANNUALLY, SEMIANNUALLY, QUARTERLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY |
| paymentStartDate | TimeStamp | Date of first payment; could be a future date. ISO 8601 date tine with milliseconds in UTC time zone. |
| paymentEndDate | TimeStamp | Date last payment will be made. ISO 8601 date tine with milliseconds in UTC time zone. |
| totalPaymentCount | Number | Total number of payments that will be produced by the annuity |
| netPresentValue | Number | Surrender or cash balance value |
| annualIncrease | Number | Percent or dollar amount of annual payment increase |
| annualIncreaseType | AnnualIncreaseType | Enum: FIXED, PERCENT, DOLLAR |
| periodCertainGuarantee | PeriodCertainGuarantee | Enum: NO PERIOD CERTAIN, 5-YEAR, 10-YEAR, 20-YEAR, 30-YEAR |
Bills
| Field | Type | Description |
|---|---|---|
| totalPaymentDue | number | Total payment due or next payment due. Monthly payment due for loans. |
| minimumPaymentDue | number | |
| dueDate | Timestamp | The date that the payment is due. ISO 8601 date tine with milliseconds in UTC time zone. |
| autoPayEnabled | boolean | Whether the user's bill is paid automatically |
| autoPayAmount | number | The amount of money the user has set to autopay this bill |
| autoPayDate | Timestamp | The date the autopayment is set to trigger for this bill. ISO 8601 date tine with milliseconds in UTC time zone. |
| pastDueAmount | number | The amount that the user should have already paid. Negative value if user owes money. |
| lastPaymentAmount | number | |
| lastPaymentDate | Timestamp | ISO 8601 date tine with milliseconds in UTC time zone. |
| statementBalance | number | The amount of the last statement. Negative value if user owes money. |
| statementDate | Timestamp | The date the statement was issued. ISO 8601 date tine with milliseconds in UTC time zone. |
Contribution
| Field | Type | Description |
|---|---|---|
| securityId | string | Unique identifier of security |
| securityIdType | SecurityIdType | Security identifier type Enum: CUSIP, ISIN, SEDOL, SICC, VALOR, WKN |
| employerMatchPercentage | Number | Employer contribution match percentage |
| employerMatchAmount | Number | Employer contribution match amount |
| employeePreTaxAmount | Number | Employee pre-tax contribution amount |
| employeePreTaxPercentage | Number | Employee pre-tax contribution percentage |
| employeeAfterTaxAmount | Number | Employee after tax contribution amount |
| employeeAfterTaxPercentage | Number | Employee after tax contribution percentage |
| employeeDeferPreTaxAmount | Number | Employee defer pre-tax contribution match amount |
| employeeDeferPreTaxPercentage | Number | Employee defer pre-tax contribution match percentage |
| employeeYearToDate | Number | Employee total year to date contribution |
| employerYearToDate | Number | Employer total year to date contribution |
| rolloverContributionPercentage | Number | Rollover contribution percentage |
| rolloverContributionAmount | Number | Rollover contribution Amount |
Currency
| Field | Type | Description |
|---|---|---|
| currencyRate | Number | Currency rate between original and converted currency |
| currencyCode | Iso4217Code | ISO 4217 currency code Enum: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL |
| originalCurrencyCode | Iso4217Code | Original ISO 4217 currency code Enum: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL |
DepositAccount
Extends and inherits all fields from Account.
| Field | Type | Description |
|---|---|---|
| balanceAsOf | Timestamp | As-of date of balances |
| currentBalance | Number | Balance of funds in account |
| openingDayBalance | Number | Day's opening fund balance |
| availableBalance | Number | Balance of funds available for use |
| annualPercentageYield | Number | Annual Percentage Yield |
| interestYtd | Number | YTD Interest |
| term | int | Term of CD in months |
| maturityDate | Timestamp | Maturity date for CDs. ISO 8601 date time with milliseconds in UTC time zone. |
DepositTransaction
Extends and inherits all fields from Transaction.
| Field | Type | Description |
|---|---|---|
| transactionType | DepositTransactionType | CHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL, BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT |
| payee | String255 | Payee name |
| checkNumber | int | Check number |
Error
An error entity which can be used at the API level for error responses or at the account level to indicate a problem specific to a particular account.
| Field | Type | Description |
|---|---|---|
| code | string | Long term persistent identifier which can be used to trace error condition back to log information |
| message | string | end-user displayable information which might help the customer diagnose an error |
FiAttribute
Financial platform provider-specific attribute.
| Field | Type | Description |
|---|---|---|
| name | string | Name of attribute |
| value | string | Value of attribute |
FiPortion
| Field | Type | Description |
|---|---|---|
| assetClass | string | FI-specific asset class |
| percent | Number | Percentage of asset class that falls under this asset |
HateoasLink
A "Hypermedia as the Engine of Application State" link.
| Field | Type | Description |
|---|---|---|
| href required | string | example: "/example/accounts/12345" |
| action | string | HTTP Method to use for the request Enum: GET, POST, PATCH, DELETE, PUT |
| types | ContentTypes | ContentTypes that can be used in the Accept header. |
Holding
| Field | Type | Description |
|---|---|---|
| holdingId | Identifier | Long term persistent identity of the holding |
| securityId | string | Unique identifier of security |
| securityIdType | SecurityIdType | Security identifier type |
| holdingName | string | Holding name or security name |
| holdingType | HoldingType | STOCK, BOND, MUTUALFUND, CD, ANNUITY, OPTION, OTHER |
| holdingSubType | HoldingSubType | MONEYMARKET, CASH |
| positionType | PositionType | LONG, SHORT |
| heldInAccount | HeldInAccount | Sub-account CASH, MARGIN, SHORT, OTHER |
| description | string | The description of the holding |
| symbol | string | Ticker / Market symbol |
| originalPurchaseDate | Timestamp | Date of original purchase. ISO 8601 date time with milliseconds in UTC time zone. |
| purchasedPrice | Number | Price of holding at the time of purchase |
| currentUnitPrice | Number | Current unit price |
| changeInPrice | Number | Change in current price compared to previous day's close |
| currentUnitPriceDate | Timestamp | Current unit price as of date. ISO 8601 date time with milliseconds in UTC time zone. |
| units | Number | Required for stock, mutual funds. Number of shares (with decimals). |
| marketValue | Number | Market value at the time of data retrieved |
| faceValue | Number | Required for bonds. Face value at the time of data retrieved. |
| averageCost | Boolean | Cost is average of all purchases for holding |
| cashAccount | Boolean | If true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account |
| rate | Number | For CDs, bonds, and other rate based holdings |
| expirationDate | Timestamp | For CDs, bonds, and other time-based holdings. ISO 8601 date time with milliseconds in UTC time zone. |
| inv401kSource | Inv401kSourceType | Source for money for this security. PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST |
| taxLots | Array of TaxLot | Breakdown by tax lot |
InsuranceAccount
Inherits and extends Account.
| Field | Type | Description |
|---|---|---|
| accountCategory | Enum: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT | |
| policyPremium | Number | The amount of the user's premium |
| policyPremiumTerm | Enum: MONTHLY, ANNUAL | |
| policyStartDate | Timestamp | ISO 8601 date time with milliseconds in UTC time zone. |
| policyEndDate | Timestamp | ISO 8601 date time with milliseconds in UTC time zone. |
| policyCoverageAmount | Number | Total amount of money the user is insured for |
| bills | Bills |
InsuranceTransaction
An Insurance transaction, inherits and extends Transaction
| Field | Type | Description |
|---|---|---|
| transactionType | Enum: PAYMENT, FEE, ADJUSTMENT, INTEREST |
InvestmentAccount
Extends and inherits all fields from Account.
| Field | Type | Description |
|---|---|---|
| balanceAsOf | Timestamp | As-of date for balances. ISO 8601 date time with milliseconds in UTC time zone. |
| allowedCheckWriting | Boolean | Check writing privileges |
| allowedOptionTrade | Boolean | Allowed to trade options |
| currentValue | Number | Total current value of all investments |
| holdings | Array of Holding | Array of holdings |
| contribution | Array of Contribution | Describes how new contributions are distributed among the available securities |
| vesting | Array of Vesting | Provides the past, present, and future vesting schedule and percentages |
| investmentLoans | Array of InvestmentLoan | Array of investment loans |
| availableCashBalance | Number | Cash balance across all sub-accounts. Should include sweep funds. |
| margin | Boolean | Margin trading is allowed |
| marginBalance | Number | Margin balance |
| shortBalance | Number | Short balance |
| rolloverAmount | Number | Rollover amount |
| employerName | string | Name of the employer in investment 401k Plan |
| brokerId | string | Unique identifier FI |
| planId | string | Plan number for Investment 401k plan |
| calendarYearFor401k | Timestamp | Date for this calendar year for 401K account. ISO 8601 date time with milliseconds in UTC time zone. |
| dailyChange | Number | Daily change |
| percentageChange | Number | Percentage change |
| pensionSource | Array of PensionSource | Array of Pension Source |
InvestmentBalance
| Field | Type | Description |
|---|---|---|
| balanceName | string | Name of the balance |
| balanceDescription | string | Description of balance |
| balanceType | InvestmentBalanceType | AMOUNT, PERCENTAGE |
| balanceValue | Number | Value of balance name |
| balanceDate | Timestamp | Date as of this balance. ISO 8601 date time with milliseconds in UTC time zone. |
InvestmentLoan
| Field | Type | Description |
|---|---|---|
| loanId | string | Unique identifier for this loan |
| loanDescription | string | Description |
| initialLoanBalance | Number | Initial loan balance amount |
| loanStartDate | Timestamp | Start date of the loan. ISO 8601 date time with milliseconds in UTC time zone. |
| currentLoanBalance | Number | Current loan principal balance amount |
| dateAsOf | Timestamp | Date and time of current loan balance. ISO 8601 date time with milliseconds in UTC time zone. |
| loanRate | Number | Loan annual interest rate for the loan |
| loanPaymentAmount | Number | Loan payment amount |
| loanPaymentFrequency | LoanPaymentFrequency | ANNUALLY, BIMONTHLY, BIWEEKLY, FOURWEEKS, MONTHLY, OTHER, QUARTERLY, SEMIANNUALLY, TWICEMONTHLY, WEEKLY |
| loanPaymentInitial | Number | Initial number of loan payments |
| loanPaymentsRemaining | int | Remaining number of loan payments |
| loanMaturityDate | Timestamp | Expected loan end date. ISO 8601 date time with milliseconds in UTC time zone. |
| loanInterestToDate | Number | Total interest paid to date on this loan |
| loanTotalProjectedInterest | Number | Total projected interest to be paid on this loan |
| loanNextPaymentDate | Timestamp | The next payment date for the loan. ISO 8601 date time with milliseconds in UTC time zone. |
InvestmentTransaction
Extends and inherits all fields from Transaction.
| Field | Type | Description |
|---|---|---|
| transactionType | InvestmentTransactionType | PURCHASED, SOLD, PURCHASEDTOCOVER, ADJUSTMENT, PURCHASETOOPEN, PURCHASETOCLOSE, SOLDTOOPEN, SOLDTOCLOSE, INTEREST, MARGININTEREST, REINVESTOFINCOME, RETURNOFCAPITAL, TRANSFER, CONTRIBUTION, FEE, OPTIONEXERCISE, OPTIONEXPIRATION, DIVIDEND, DIVIDENDREINVEST, SPLIT, CLOSURE, INCOME, EXPENSE, CLOSUREOPT, INVEXPENSE, JRNLSEC, JRNLFUND, OTHER, DIV, SRVCHG, DEP, DEPOSIT, ATM, POS, XFER, CHECK, PAYMENT, CASH, DIRECTDEP, DIRECTDEBIT, REPEATPMT |
| shares | Number | Required for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account. |
| faceValue | Number | Cash value for bonds |
| price | Number | Unit purchase price |
| securityId | string | Unique identifier of security |
| securityIdType | SecurityIdType | Security identifier type |
| securityType | SecurityType | STOCK, MUTUALFUND, DEBT, OPTION, SWEEP, OTHER, BOND |
| symbol | string | Ticker symbol |
| markup | Number | Portion of unit price that is attributed to the dealer markup |
| commission | Number | Transaction commission |
| taxes | Number | Taxes on the trade |
| fees | Number | Fees applied to the trade |
| load | Number | Load on the transaction |
| inv401kSource | Inv401kSourceType | Source of money. PRETAX, AFTERTAX, MATCH,PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST |
| confirmationNumber | string | Confirmation number of the transaction |
| fractionalCash | Number | Cash for fractional units (used for stock splits) |
| incomeType | IncomeType | Type of investment income: CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC |
| oldUnits | Number | Number of shares before split |
| splitRatioNumerator | Number | Split ratio numerator |
| splitRatioDenominator | Number | Split ratio denominator |
| newUnits | Number | Number of shares after split |
| subAccountSec | SubAccountType | Sub-account security Type: CASH, MARGIN, SHORT and OTHERS |
| subAccountFund | SubAccountType | From which account money came in: CASH, MARGIN, SHORT and OTHERS |
| loanId | string | For 401k accounts only. This indicates the transaction was due to a loan or a loan repayment. |
| loanPrincipal | Number | How much loan pre-payment is principal |
| loanInterest | Number | How much loan pre-payment is interest |
| payrollDate | Timestamp | The date for the 401k transaction was obtained in payroll. ISO 8601 date time with milliseconds in UTC time zone. |
| priorYearContrib | Boolean | Indicates this buy was made using prior years contribution. TRUE or FALSE |
| withholding | Number | Federal tax withholding |
| taxExempt | Boolean | Tax-exempt transaction TRUE or FALSE |
| gain | Number | For sales |
| stateWithholding | Number | State tax withholding |
| penalty | Number | Indicates amount withheld due to a penalty |
| runningBalance | Number | Running balance of the position |
| unitPrice | Number | Price per commonly-quoted unit. Does not include markup/markdown, unitprice. Share price for stocks, mutual funds, and others. Percentage of par for bonds. Per share (not contract) for options. |
| units | Number | For security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options. |
| unitType | UnitType | SHARES, CURRENCY |
| transactionReason | TransactionReason | Reason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity) |
| accruedInterest | Amount | Accrued Interest |
| transferAction | string | Transfer direction [IN or OUT] |
| positionType | PositionType | LONG, SHORT |
LineItem
| Field | Type | Description |
|---|---|---|
| description | string | The description of the line item |
| amount | Number | The amount of money attributable to this line item |
| checkNumber | int | Check number |
| memo | String255 | Secondary item description |
| reference | string | A reference number |
| imageIds | Array of string | Array of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt |
| links | Array of HateoasLink | Array of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt |
LoanAccount
Extends and inherits all fields from Account.
| Field | Type | Description |
|---|---|---|
| balanceAsOf | Timestamp | As-of date for balances. ISO 8601 date time with milliseconds in UTC time zone. |
| principalBalance | Number | Principal balance of loan |
| escrowBalance | Number | Escrow balance of loan |
| originalPrincipal | Number | Original principal of loan |
| originatingDate | Timestamp | Loan origination date. ISO 8601 date time with milliseconds in UTC time zone. |
| loanTerm | int | Term of loan in months |
| totalNumberOfPayments | int | Total number of payments |
| nextPaymentAmount | Number | Amount of next payment |
| nextPaymentDate | Timestamp | Date of next payment. ISO 8601 date time with milliseconds in UTC time zone. |
| paymentFrequency | PaymentFrequency | DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY |
| compoundingPeriod | CompoundingPeriod | DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY |
| payoffAmount | Number | Payoff amount |
| lastPaymentAmount | Number | Last payment amount |
| lastPaymentDate | Timestamp | Last payment date. ISO 8601 date time with milliseconds in UTC time zone. |
| maturityDate | Timestamp | Maturity date. ISO 8601 date time with milliseconds in UTC time zone. |
| interestPaidYearToDate | Number | Interest paid year to date |
LoanTransaction
Extends and inherits all fields from Transaction.
| Field | Type | Description |
|---|---|---|
| transactionType | LoanTransactionType | PAYMENT, FEE, ADJUSTMENT, INTEREST |
LocAccount
Extends and inherits all fields from Account.
| Field | Type | Description |
|---|---|---|
| balanceAsOf | Timestamp | As-of date of balances. ISO 8601 date time with milliseconds in UTC time zone. |
| creditLine | Number | Credit limit |
| availableCredit | Number | Available credit |
| nextPaymentAmount | Number | Amount of next payment |
| nextPaymentDate | Timestamp | Due date of next payment. ISO 8601 date time with milliseconds in UTC time zone. |
| principalBalance | Number | Principal balance |
| currentBalance | Number | Current balance LOC |
| minimumPaymentAmount | Number | Minimum payment amount |
| lastPaymentAmount | Number | Last payment amount |
| lastPaymentDate | Timestamp | Last payment date. ISO 8601 date time with milliseconds in UTC time zone. |
| pastDueAmount | Number | Past Due Amount |
| lastStmtBalance | Number | Last Statement Balance |
| lastStmtDate | Timestamp | Last Statement Date. ISO 8601 date time with milliseconds in UTC time zone. |
| pointsAccrued | Number | Points accrued |
| currentRewardsBalance | Number | Current rewards balance |
| pointsRedeemed | Number | Points redeemed |
| purchasesApr | Number | Purchases APR |
| advancesApr | Number | Advances APR |
| cashAdvanceLimit | Number | Cash advance limit |
| availableCash | Number | Available cash |
| financeCharges | Number | Finance charges |
LocTransaction
A line of credit transaction. Extends and inherits all fields from Transaction.
| Field | Type | Description |
|---|---|---|
| transactionType | LocTransactionType | CHECK, WITHDRAWAL, PAYMENT, FEE, ADJUSTMENT, INTEREST |
| checkNumber | int | Check number |
OpenOrder
| Field | Type | Description |
|---|---|---|
| orderId | Identifier | Long term persistent identity of the order. Id for this order transaction. |
| securityId | string | Unique identifier of security |
| securityIdType | SecurityIdType | Security identifier type |
| symbol | string | Market symbol |
| description | string | Description of order |
| units | Number | Number of units (shares or bonds etc). |
| orderType | OrderType | Type of order BUY, SELL, BUYTOCOVER, BUYTOOPEN, SELLTOCOVER, SELLTOOPEN, SELLSHORT, SELLCLOSE |
| orderDate | Timestamp | Order date. ISO 8601 date time with milliseconds in UTC time zone. |
| unitPrice | Number | Unit price |
| unitType | UnitType | Type of unit SHARES, CURRENCY |
| orderDuration | OrderDuration | This order is good for DAY, GOODTILLCANCEL, IMMEDIATE |
| subAccount | SubAccountType | CASH, MARGIN, SHORT, OTHERS |
| limitPrice | Number | Limit price |
| stopPrice | Number | Stop price |
| inv401kSource | Inv401kSourceType | For 401(k) accounts, source of money for this order. PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST. Default if not present is OTHERNONVEST. |
PageMetadata
| Field | Type | Description |
|---|---|---|
| nextOffset | string | Opaque identifier. Does not need to be numeric or have any specific pattern. Implementation specific. example: "2" |
| prevOffset | string | Opaque identifier. Does not need to be numeric or have any specific pattern. Implementation specific. example: "2" |
| totalElements | integer | Total number of elements example: 3 |
PaymentDetails
| Field | Type | Description |
|---|---|---|
| principalAmount | Number | The amount of payment applied to principal |
| interestAmount | Number | The amount of payment applied to interest |
| insuranceAmount | Number | The amount of payment applied to life/ health/accident insurance on the loan |
| escrowAmount | Number | The amount of payment applied to escrow |
| pmiAmount | Number | The amount of payment applied to PMI |
| feesAmount | Number | The amount of payment applied to fees |
PensionSource
| Field | Type | Description |
|---|---|---|
| displayName | string | Name of the Source |
| amount | number | Benefit Amount |
| paymentOption | string | Form of payment |
| asOfDate | Timestamp | Date benefit was calculated. ISO 8601 date tine with milliseconds in UTC time zone. |
| frequency | PaymentFrequency | Frequency of Payment |
| startDate | Timestamp | Assumed retirement date - As of date amount is payable. ISO 8601 date tine with milliseconds in UTC time zone. |
Portion
| Field | Type | Description |
|---|---|---|
| assetClass | AssetClass | DOMESTICBOND, INTLBOND, LARGESTOCK, SMALLSTOCK, INTLSTOCK, MONEYMARKET, OTHER |
| percent | Number | Percentage of asset class that falls under this asset |
TaxLot
| Field | Type | Description |
|---|---|---|
| originalPurchaseDate | Timestamp | Lot acquired date. ISO 8601 date tine with milliseconds in UTC time zone. |
| quantity | Number | Lot quantity |
| purchasedPrice | Number | Original purchase price |
| costBasis | Number | Total amount of money spent acquiring this lot including any fees or commission expenses incurred |
| currentValue | Number | Lot market value |
| positionType | PositionType | LONG, SHORT |
Transaction
| Field | Type | Description |
|---|---|---|
| accountId | Identifier | Corresponds to AccountId in Account |
| transactionId | Identifier | Long term persistent identity of the transaction (unique to account) |
| referenceTransactionId | Identifier | For reverse postings, the identity of the transaction being reversed. For the correction transaction, the identity of the reversing post. For credit card posting transactions, the identity of the authorization transaction. |
| postedTimestamp | Timestamp | The date and time that the transaction was posted to the account. If not provided then TransactionTimestamp can be used as PostedTimeStamp. ISO 8601 date tine with milliseconds in UTC time zone. |
| transactionTimestamp | Timestamp | The date and time that the transaction was added to the server backend systems. ISO 8601 date tine with milliseconds in UTC time zone. |
| description | string | The description of the transaction |
| memo | String255 | Secondary transaction description |
| debitCreditMemo | DebitCreditMemo | DEBIT, CREDIT, MEMO |
| category | string | Transaction category, preferably MCC or SIC. |
| subCategory | string | Transaction category detail |
| reference | string | A tracking reference identifier |
| status | TransactionStatus | PENDING, MEMO, POSTED, AUTHORIZATION |
| amount | Number | The amount of money in the account currency |
| foreignAmount | Number | The amount of money in the foreign currency |
| foreignCurrency | Iso4217Code | The ISO 4217 code of the foreign currency |
| imageIds | Array of string | Array of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt |
| lineItem | Array of LineItem | Breakdown of the transaction details |
| fiAttributes | Array of FiAttribute | Array of FI-specific attributes |
| links | Array of HateoasLink | Array of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt |
Vesting
| Field | Type | Description |
|---|---|---|
| vestingDate | Timestamp | Vesting date. ISO 8601 date tine with milliseconds in UTC time zone. |
| symbol | string | Security symbol |
| strikePrice | Number | Strike price |
| vestingPercentage | Number | Vesting percentage |
| otherVestAmount | Number | Other vest amount |
| otherVestPercentage | Number | Other vest percentage |
| vestedBalance | Number | Vested balance |
| unVestedBalance | Number | Unvested balance |
| vestedQuantity | Number | Vested quantity |
| unVestedQuantity | Number | Unvested quantity |
Updated 2 days ago