Account

Extends and inherits all fields from AccountDescriptor.

FieldTypeDescription
parentAccountIdIdentifierLong-term persistent identity of the parent account. This is used to group accounts.
lineOfBusinessstringThe line of business, such as consumer, consumer joint, small business, corporate, etc.
routingTransitNumberstringRouting transit number (RTN) associated with account number at data provider.
balanceTypeBalanceTypeASSET (positive transaction amount increases balance), LIABILITY (positive transaction amount decreases balance)
interestRateNumberInterest Rate of Account
interestRateTypeInterestRateTypeFIXED or VARIABLE
interestRateAsOfTimestampDate of account's interest rate. ISO 8601 date time with milliseconds in UTC time zone.
priorInterestRateNumberPrevious Interest Rate of Account
transferInBooleanAccount is eligible for incoming transfers
transferOutBooleanAccount is eligible for outgoing transfers
micrNumberString64MICR Number
lastActivityDateTimestampDate that last transaction occurred on account. ISO 8601 date time with milliseconds in UTC time zone.
transactionsIncludedBooleanDefault 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.
currencyCurrency

AccountDescriptor

Minimal information about the account for use in lightweight arrays.

FieldTypeDescription
accountIdIdentifierLong-term persistent identity of the account. Not an account number. This identity must be unique to the data provider.
errorErrorPresent if an error was encountered while retrieving this account
accountTypeAccountTypeEnum: 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
accountNumberstringFull account number.
accountNumberDisplaystringAccount display number for the end-user's handle at data provider. This is to be displayed by the data recipient.
productNamestringMarketed product name for this account. Used in UIs to assist in account selection
nickNamestringName given by the user. Used in UIs to assist in account selection
statusAccountStatusEnum: OPEN, CLOSED, PENDINGOPEN, PENDINGCLOSE, DELINQUENT, PAID, NEGATIVECURRENTBALANCE
descriptionstringDescription of account

Accounts

An optionally paginated array of accounts.

FieldTypeDescription
TotalintTotal number of results in this collection across all pages

AnnuityAccount

FieldTypeDescription
annuityProductTypeAnnuityProductTypeDERERRED, IMMEDIATE, CURRENCY, SHARES
annuityValueBasisAnnuityValueBasisFIXED, VARIABLE
paymentAmountNumberAmount of the recurring payment.
paymentFrequencyPaymentFrequencyANNUALLY, SEMIANNUALLY, QUARTERLY, MONTHLY, SEMIMONTHLY, BIWEEKLY, WEEKLY, DAILY
paymentStartDateTimeStampDate of first payment; could be a future date. ISO 8601 date tine with milliseconds in UTC time zone.
paymentEndDateTimeStampDate last payment will be made. ISO 8601 date tine with milliseconds in UTC time zone.
totalPaymentCountNumberTotal number of payments that will be produced by the annuity
netPresentValueNumberSurrender or cash balance value
annualIncreaseNumberPercent or dollar amount of annual payment increase
annualIncreaseTypeAnnualIncreaseTypeEnum: FIXED, PERCENT, DOLLAR
periodCertainGuaranteePeriodCertainGuaranteeEnum: NO PERIOD CERTAIN, 5-YEAR, 10-YEAR, 20-YEAR, 30-YEAR

Bills

FieldTypeDescription
totalPaymentDuenumberTotal payment due or next payment due. Monthly payment due for loans.
minimumPaymentDuenumber
dueDateTimestampThe date that the payment is due. ISO 8601 date tine with milliseconds in UTC time zone.
autoPayEnabledbooleanWhether the user's bill is paid automatically
autoPayAmountnumberThe amount of money the user has set to autopay this bill
autoPayDateTimestampThe date the autopayment is set to trigger for this bill. ISO 8601 date tine with milliseconds in UTC time zone.
pastDueAmountnumberThe amount that the user should have already paid. Negative value if user owes money.
lastPaymentAmountnumber
lastPaymentDateTimestampISO 8601 date tine with milliseconds in UTC time zone.
statementBalancenumberThe amount of the last statement. Negative value if user owes money.
statementDateTimestampThe date the statement was issued. ISO 8601 date tine with milliseconds in UTC time zone.

Contribution

FieldTypeDescription
securityIdstringUnique identifier of security
securityIdTypeSecurityIdTypeSecurity identifier type
Enum: CUSIP, ISIN, SEDOL, SICC, VALOR, WKN
employerMatchPercentageNumberEmployer contribution match percentage
employerMatchAmountNumberEmployer contribution match amount
employeePreTaxAmountNumberEmployee pre-tax contribution amount
employeePreTaxPercentageNumberEmployee pre-tax contribution percentage
employeeAfterTaxAmountNumberEmployee after tax contribution amount
employeeAfterTaxPercentageNumberEmployee after tax contribution percentage
employeeDeferPreTaxAmountNumberEmployee defer pre-tax contribution match amount
employeeDeferPreTaxPercentageNumberEmployee defer pre-tax contribution match percentage
employeeYearToDateNumberEmployee total year to date contribution
employerYearToDateNumberEmployer total year to date contribution
rolloverContributionPercentageNumberRollover contribution percentage
rolloverContributionAmountNumberRollover contribution Amount

Currency

FieldTypeDescription
currencyRateNumberCurrency rate between original and converted currency
currencyCodeIso4217CodeISO 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
originalCurrencyCodeIso4217CodeOriginal 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.

FieldTypeDescription
balanceAsOfTimestampAs-of date of balances
currentBalanceNumberBalance of funds in account
openingDayBalanceNumberDay's opening fund balance
availableBalanceNumberBalance of funds available for use
annualPercentageYieldNumberAnnual Percentage Yield
interestYtdNumberYTD Interest
termintTerm of CD in months
maturityDateTimestampMaturity date for CDs. ISO 8601 date time with milliseconds in UTC time zone.

DepositTransaction

Extends and inherits all fields from Transaction.

FieldTypeDescription
transactionTypeDepositTransactionTypeCHECK, WITHDRAWAL, TRANSFER, POSDEBIT, ATMWITHDRAWAL, BILLPAYMENT, FEE, DEPOSIT, ADJUSTMENT, INTEREST, DIVIDEND, DIRECTDEPOSIT, ATMDEPOSIT, POSCREDIT
payeeString255Payee name
checkNumberintCheck 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.

FieldTypeDescription
codestringLong term persistent identifier which can be used to trace error condition back to log information
messagestringend-user displayable information which might help the customer diagnose an error

FiAttribute

Financial platform provider-specific attribute.

FieldTypeDescription
namestringName of attribute
valuestringValue of attribute

FiPortion

FieldTypeDescription
assetClassstringFI-specific asset class
percentNumberPercentage of asset class that falls under this asset

HateoasLink

A "Hypermedia as the Engine of Application State" link.

FieldTypeDescription
href
required
stringexample: "/example/accounts/12345"
actionstringHTTP Method to use for the request
Enum: GET, POST, PATCH, DELETE, PUT
typesContentTypesContentTypes that can be used in the Accept header.

Holding

FieldTypeDescription
holdingIdIdentifierLong term persistent identity of the holding
securityIdstringUnique identifier of security
securityIdTypeSecurityIdTypeSecurity identifier type
holdingNamestringHolding name or security name
holdingTypeHoldingTypeSTOCK, BOND, MUTUALFUND, CD, ANNUITY, OPTION, OTHER
holdingSubTypeHoldingSubTypeMONEYMARKET, CASH
positionTypePositionTypeLONG, SHORT
heldInAccountHeldInAccountSub-account CASH, MARGIN, SHORT, OTHER
descriptionstringThe description of the holding
symbolstringTicker / Market symbol
originalPurchaseDateTimestampDate of original purchase. ISO 8601 date time with milliseconds in UTC time zone.
purchasedPriceNumberPrice of holding at the time of purchase
currentUnitPriceNumberCurrent unit price
changeInPriceNumberChange in current price compared to previous day's close
currentUnitPriceDateTimestampCurrent unit price as of date. ISO 8601 date time with milliseconds in UTC time zone.
unitsNumberRequired for stock, mutual funds. Number of shares (with decimals).
marketValueNumberMarket value at the time of data retrieved
faceValueNumberRequired for bonds. Face value at the time of data retrieved.
averageCostBooleanCost is average of all purchases for holding
cashAccountBooleanIf true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account
rateNumberFor CDs, bonds, and other rate based holdings
expirationDateTimestampFor CDs, bonds, and other time-based holdings. ISO 8601 date time with milliseconds in UTC time zone.
inv401kSourceInv401kSourceTypeSource for money for this security. PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST
taxLotsArray of TaxLotBreakdown by tax lot

InsuranceAccount

Inherits and extends Account.

FieldTypeDescription
accountCategoryEnum: DEPOSIT_ACCOUNT, INVESTMENT_ACCOUNT, LOAN_ACCOUNT, LOC_ACCOUNT, INSURANCE_ACCOUNT
policyPremiumNumberThe amount of the user's premium
policyPremiumTermEnum: MONTHLY, ANNUAL
policyStartDateTimestampISO 8601 date time with milliseconds in UTC time zone.
policyEndDateTimestampISO 8601 date time with milliseconds in UTC time zone.
policyCoverageAmountNumberTotal amount of money the user is insured for
billsBills

InsuranceTransaction

An Insurance transaction, inherits and extends Transaction

FieldTypeDescription
transactionTypeEnum: PAYMENT, FEE, ADJUSTMENT, INTEREST

InvestmentAccount

Extends and inherits all fields from Account.

FieldTypeDescription
balanceAsOfTimestampAs-of date for balances. ISO 8601 date time with milliseconds in UTC time zone.
allowedCheckWritingBooleanCheck writing privileges
allowedOptionTradeBooleanAllowed to trade options
currentValueNumberTotal current value of all investments
holdingsArray of HoldingArray of holdings
contributionArray of ContributionDescribes how new contributions are distributed among the available securities
vestingArray of VestingProvides the past, present, and future vesting schedule and percentages
investmentLoansArray of InvestmentLoanArray of investment loans
availableCashBalanceNumberCash balance across all sub-accounts. Should include sweep funds.
marginBooleanMargin trading is allowed
marginBalanceNumberMargin balance
shortBalanceNumberShort balance
rolloverAmountNumberRollover amount
employerNamestringName of the employer in investment 401k Plan
brokerIdstringUnique identifier FI
planIdstringPlan number for Investment 401k plan
calendarYearFor401kTimestampDate for this calendar year for 401K account. ISO 8601 date time with milliseconds in UTC time zone.
dailyChangeNumberDaily change
percentageChangeNumberPercentage change
pensionSourceArray of PensionSourceArray of Pension Source

InvestmentBalance

FieldTypeDescription
balanceNamestringName of the balance
balanceDescriptionstringDescription of balance
balanceTypeInvestmentBalanceTypeAMOUNT, PERCENTAGE
balanceValueNumberValue of balance name
balanceDateTimestampDate as of this balance. ISO 8601 date time with milliseconds in UTC time zone.

InvestmentLoan

FieldTypeDescription
loanIdstringUnique identifier for this loan
loanDescriptionstringDescription
initialLoanBalanceNumberInitial loan balance amount
loanStartDateTimestampStart date of the loan. ISO 8601 date time with milliseconds in UTC time zone.
currentLoanBalanceNumberCurrent loan principal balance amount
dateAsOfTimestampDate and time of current loan balance. ISO 8601 date time with milliseconds in UTC time zone.
loanRateNumberLoan annual interest rate for the loan
loanPaymentAmountNumberLoan payment amount
loanPaymentFrequencyLoanPaymentFrequencyANNUALLY, BIMONTHLY, BIWEEKLY, FOURWEEKS, MONTHLY, OTHER, QUARTERLY, SEMIANNUALLY, TWICEMONTHLY, WEEKLY
loanPaymentInitialNumberInitial number of loan payments
loanPaymentsRemainingintRemaining number of loan payments
loanMaturityDateTimestampExpected loan end date. ISO 8601 date time with milliseconds in UTC time zone.
loanInterestToDateNumberTotal interest paid to date on this loan
loanTotalProjectedInterestNumberTotal projected interest to be paid on this loan
loanNextPaymentDateTimestampThe next payment date for the loan. ISO 8601 date time with milliseconds in UTC time zone.

InvestmentTransaction

Extends and inherits all fields from Transaction.

FieldTypeDescription
transactionTypeInvestmentTransactionTypePURCHASED, 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
sharesNumberRequired for stock, mutual funds. Number of shares (with decimals). Negative numbers indicate securities are being removed from the account.
faceValueNumberCash value for bonds
priceNumberUnit purchase price
securityIdstringUnique identifier of security
securityIdTypeSecurityIdTypeSecurity identifier type
securityTypeSecurityTypeSTOCK, MUTUALFUND, DEBT, OPTION, SWEEP, OTHER, BOND
symbolstringTicker symbol
markupNumberPortion of unit price that is attributed to the dealer markup
commissionNumberTransaction commission
taxesNumberTaxes on the trade
feesNumberFees applied to the trade
loadNumberLoad on the transaction
inv401kSourceInv401kSourceTypeSource of money. PRETAX, AFTERTAX, MATCH,PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST
confirmationNumberstringConfirmation number of the transaction
fractionalCashNumberCash for fractional units (used for stock splits)
incomeTypeIncomeTypeType of investment income: CGLONG (capital gains-long term), CGSHORT (capital gains-short term), MISC
oldUnitsNumberNumber of shares before split
splitRatioNumeratorNumberSplit ratio numerator
splitRatioDenominatorNumberSplit ratio denominator
newUnitsNumberNumber of shares after split
subAccountSecSubAccountTypeSub-account security Type: CASH, MARGIN, SHORT and OTHERS
subAccountFundSubAccountTypeFrom which account money came in: CASH, MARGIN, SHORT and OTHERS
loanIdstringFor 401k accounts only. This indicates the transaction was due to a loan or a loan repayment.
loanPrincipalNumberHow much loan pre-payment is principal
loanInterestNumberHow much loan pre-payment is interest
payrollDateTimestampThe date for the 401k transaction was obtained in payroll. ISO 8601 date time with milliseconds in UTC time zone.
priorYearContribBooleanIndicates this buy was made using prior years contribution. TRUE or FALSE
withholdingNumberFederal tax withholding
taxExemptBooleanTax-exempt transaction TRUE or FALSE
gainNumberFor sales
stateWithholdingNumberState tax withholding
penaltyNumberIndicates amount withheld due to a penalty
runningBalanceNumberRunning balance of the position
unitPriceNumberPrice 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.
unitsNumberFor security-based actions other than stock splits, quantity. Shares for stocks, mutual funds, and others. Face value for bonds. Contracts for options.
unitTypeUnitTypeSHARES, CURRENCY
transactionReasonTransactionReasonReason for this transaction; CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity)
accruedInterestAmountAccrued Interest
transferActionstringTransfer direction [IN or OUT]
positionTypePositionTypeLONG, SHORT

LineItem

FieldTypeDescription
descriptionstringThe description of the line item
amountNumberThe amount of money attributable to this line item
checkNumberintCheck number
memoString255Secondary item description
referencestringA reference number
imageIdsArray of stringArray of image identifiers (unique to transaction) used to retrieve images of check or transaction receipt
linksArray of HateoasLinkArray of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt

LoanAccount

Extends and inherits all fields from Account.

FieldTypeDescription
balanceAsOfTimestampAs-of date for balances. ISO 8601 date time with milliseconds in UTC time zone.
principalBalanceNumberPrincipal balance of loan
escrowBalanceNumberEscrow balance of loan
originalPrincipalNumberOriginal principal of loan
originatingDateTimestampLoan origination date. ISO 8601 date time with milliseconds in UTC time zone.
loanTermintTerm of loan in months
totalNumberOfPaymentsintTotal number of payments
nextPaymentAmountNumberAmount of next payment
nextPaymentDateTimestampDate of next payment. ISO 8601 date time with milliseconds in UTC time zone.
paymentFrequencyPaymentFrequencyDAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY
compoundingPeriodCompoundingPeriodDAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY
payoffAmountNumberPayoff amount
lastPaymentAmountNumberLast payment amount
lastPaymentDateTimestampLast payment date. ISO 8601 date time with milliseconds in UTC time zone.
maturityDateTimestampMaturity date. ISO 8601 date time with milliseconds in UTC time zone.
interestPaidYearToDateNumberInterest paid year to date

LoanTransaction

Extends and inherits all fields from Transaction.

FieldTypeDescription
transactionTypeLoanTransactionTypePAYMENT, FEE, ADJUSTMENT, INTEREST

LocAccount

Extends and inherits all fields from Account.

FieldTypeDescription
balanceAsOfTimestampAs-of date of balances. ISO 8601 date time with milliseconds in UTC time zone.
creditLineNumberCredit limit
availableCreditNumberAvailable credit
nextPaymentAmountNumberAmount of next payment
nextPaymentDateTimestampDue date of next payment. ISO 8601 date time with milliseconds in UTC time zone.
principalBalanceNumberPrincipal balance
currentBalanceNumberCurrent balance LOC
minimumPaymentAmountNumberMinimum payment amount
lastPaymentAmountNumberLast payment amount
lastPaymentDateTimestampLast payment date. ISO 8601 date time with milliseconds in UTC time zone.
pastDueAmountNumberPast Due Amount
lastStmtBalanceNumberLast Statement Balance
lastStmtDateTimestampLast Statement Date. ISO 8601 date time with milliseconds in UTC time zone.
pointsAccruedNumberPoints accrued
currentRewardsBalanceNumberCurrent rewards balance
pointsRedeemedNumberPoints redeemed
purchasesAprNumberPurchases APR
advancesAprNumberAdvances APR
cashAdvanceLimitNumberCash advance limit
availableCashNumberAvailable cash
financeChargesNumberFinance charges

LocTransaction

A line of credit transaction. Extends and inherits all fields from Transaction.

FieldTypeDescription
transactionTypeLocTransactionTypeCHECK, WITHDRAWAL, PAYMENT, FEE, ADJUSTMENT, INTEREST
checkNumberintCheck number

OpenOrder

FieldTypeDescription
orderIdIdentifierLong term persistent identity of the order. Id for this order transaction.
securityIdstringUnique identifier of security
securityIdTypeSecurityIdTypeSecurity identifier type
symbolstringMarket symbol
descriptionstringDescription of order
unitsNumberNumber of units (shares or bonds etc).
orderTypeOrderTypeType of order BUY, SELL, BUYTOCOVER, BUYTOOPEN, SELLTOCOVER, SELLTOOPEN, SELLSHORT, SELLCLOSE
orderDateTimestampOrder date. ISO 8601 date time with milliseconds in UTC time zone.
unitPriceNumberUnit price
unitTypeUnitTypeType of unit SHARES, CURRENCY
orderDurationOrderDurationThis order is good for DAY, GOODTILLCANCEL, IMMEDIATE
subAccountSubAccountTypeCASH, MARGIN, SHORT, OTHERS
limitPriceNumberLimit price
stopPriceNumberStop price
inv401kSourceInv401kSourceTypeFor 401(k) accounts, source of money for this order. PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST. Default if not present is OTHERNONVEST.

PageMetadata

FieldTypeDescription
nextOffsetstringOpaque identifier. Does not need to be numeric or have any specific pattern. Implementation specific.
example: "2"
prevOffsetstringOpaque identifier. Does not need to be numeric or have any specific pattern. Implementation specific.
example: "2"
totalElementsintegerTotal number of elements
example: 3

PaymentDetails

FieldTypeDescription
principalAmountNumberThe amount of payment applied to principal
interestAmountNumberThe amount of payment applied to interest
insuranceAmountNumberThe amount of payment applied to life/ health/accident insurance on the loan
escrowAmountNumberThe amount of payment applied to escrow
pmiAmountNumberThe amount of payment applied to PMI
feesAmountNumberThe amount of payment applied to fees

PensionSource

FieldTypeDescription
displayNamestringName of the Source
amountnumberBenefit Amount
paymentOptionstringForm of payment
asOfDateTimestampDate benefit was calculated. ISO 8601 date tine with milliseconds in UTC time zone.
frequencyPaymentFrequencyFrequency of Payment
startDateTimestampAssumed retirement date - As of date amount is payable. ISO 8601 date tine with milliseconds in UTC time zone.

Portion

FieldTypeDescription
assetClassAssetClassDOMESTICBOND, INTLBOND, LARGESTOCK, SMALLSTOCK, INTLSTOCK, MONEYMARKET, OTHER
percentNumberPercentage of asset class that falls under this asset

TaxLot

FieldTypeDescription
originalPurchaseDateTimestampLot acquired date. ISO 8601 date tine with milliseconds in UTC time zone.
quantityNumberLot quantity
purchasedPriceNumberOriginal purchase price
costBasisNumberTotal amount of money spent acquiring this lot including any fees or commission expenses incurred
currentValueNumberLot market value
positionTypePositionTypeLONG, SHORT

Transaction

FieldTypeDescription
accountIdIdentifierCorresponds to AccountId in Account
transactionIdIdentifierLong term persistent identity of the transaction (unique to account)
referenceTransactionIdIdentifierFor 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.
postedTimestampTimestampThe 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.
transactionTimestampTimestampThe date and time that the transaction was added to the server backend systems. ISO 8601 date tine with milliseconds in UTC time zone.
descriptionstringThe description of the transaction
memoString255Secondary transaction description
debitCreditMemoDebitCreditMemoDEBIT, CREDIT, MEMO
categorystringTransaction category, preferably MCC or SIC.
subCategorystringTransaction category detail
referencestringA tracking reference identifier
statusTransactionStatusPENDING, MEMO, POSTED, AUTHORIZATION
amountNumberThe amount of money in the account currency
foreignAmountNumberThe amount of money in the foreign currency
foreignCurrencyIso4217CodeThe ISO 4217 code of the foreign currency
imageIdsArray of stringArray of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt
lineItemArray of LineItemBreakdown of the transaction details
fiAttributesArray of FiAttributeArray of FI-specific attributes
linksArray of HateoasLinkArray of Image Identifiers (unique to Transaction) used to retrieve Images of check or transaction receipt

Vesting

FieldTypeDescription
vestingDateTimestampVesting date. ISO 8601 date tine with milliseconds in UTC time zone.
symbolstringSecurity symbol
strikePriceNumberStrike price
vestingPercentageNumberVesting percentage
otherVestAmountNumberOther vest amount
otherVestPercentageNumberOther vest percentage
vestedBalanceNumberVested balance
unVestedBalanceNumberUnvested balance
vestedQuantityNumberVested quantity
unVestedQuantityNumberUnvested quantity