Accounts

object

accounts

array of objects

An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)

Any of:

investmentAccount

holdings

array of objects

Array of holdings

assetClasses

array of objects

Percent breakdown by asset class.

object

assetClass

string

DOMESTICBONDINTLBONDLARGESTOCKSMALLSTOCKINTLSTOCKMONEYMARKETOTHER

percent

number

Percentage of asset class that falls under this asset

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.

changeInPrice

number

Change in current price compared to previous day's close

currency

object

currencyCode

string

Iso 4217 currency code.

currencyRate

number

Currency rate between original and converted currency.

originalCurrencyCode

string

Iso 4217 currency code.

currentUnitPrice

number

currentUnitPriceDate

string

Current unit price as of date

description

string

Description of the holding

expirationDate

string

For CDs, bonds, and other time-based holdings.

faceValue

number

Face value at the time of data retrieved.

fiAssetClasses

array of objects

Percent breakdown by FI-specific asset class percentage breakdown

object

assetClass

string

FI-specific asset class

percent

number

Percentage of asset class that falls under this asset

fiAttributes

array

heldInAccount

string

Sub-account

CASHMARGINSHORTOTHER

holdingId

string

Long term persistent identity of the holding

holdingName

string

Holding name or security name

holdingSubType

string

MONEYMARKETCASH

holdingType

string

STOCKBONDMUTUALFUNDCDANNUITYOPTIONOTHER

inv401kSurce

string

Source for money for this security.

PRETAXAFTERTAXMATCHPROFITSHARINGROLLOVEROTHERVESTOTHERNONVEST

marketValue

number

Market value at the time of data retrieved

originalPurchaseDate

string

Date of original purchase

positionType

string

purchasedPrice

number

Price of holding at the time of purchase

rate

number

For CDs, bonds, and other rate based holdings.

securityId

string

Unique identifier of security

securityIdType

string

symbol

string

Ticker / Market symbol

taxLots

array

units

number

Number of shares (with decimals).

openOrders

array of objects

Array of open orders

object

orderId

string

Long term persistent identity of the order. Id for this order transaction.

securityId

string

Unique identifier of the security.

securityIdType

string

symbol

string

Market symbol

description

string

Description of order

units

number

Number of units (shares, bonds, etc.)

orderType

string

Type of order.

BUYSELLBUYTOCOVERBUYTOOPENSELLTOCOVERSELLTOOPENSELLSHORTSELLCLOSE

orderDate

string

Order date

unitPrice

number

Unit price

unitType

string

orderDuration

string

This order is good for DAY, GOODTILLCANCEL, IMMEDIATE

DAYGOODTILLCANCELIMMEDIATE

subAccount

string

CASHMARGINSHORTOTHER

limitPrice

number

Limit Price

stopPrice

number

Stop price

inv401kSource

string

contribution

array of objects

Array of contribution objects. Describes how new contributions are distributed among the available securities

object

securityId

string

Unique identifier of security

securityIdType

string

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

vesting

array of objects

Array of vesting objects. Provides the past, present, and future vesting schedule and percentages

object

vestingDate

string

Vesting date

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 qualtity

unVestedQuantity

number

Unvested quantity

investmentLoans

array of objects

Array of investment loans

loanId

string

Unique identifier for this loan

loanDescription

string

Description

initialLoanBalance

number

Initial loan balance amount

loanStartDate

string

Start date of the loan

currentLoanBalance

number

Current loan principal balance amount

dateAsOf

string

Date and time of current loan balance

loanRate

number

Loan annual interest rate for the loan

loanPaymentAmount

number

Loan payment amount

loanPaymentFrequency

string

WEEKLYBIWEEKLYTWICEMONTHLYMONTHLYFOURWEEKSBIMONTHLYQUARTERLYSEMIANNUALLYANNUALLYOTHER

loanPaymentInitial

number

Initial number of loan payments

loanPaymentsRemaining

integer

Remaining number of loan payments

loanMaturityDate

string

Expected loan end date

loanInterestToDate

number

Total interest paid to date on this loan

loanTotalProjectedInterest

number

Total projected interest to be paid on this loan

loanNextPaymentDate

string

The next payment date for the loan

pensionSource

array of objects

Array of Pension Source

displayName

string

Name of the Source

amount

number

Benefit Amount

paymentOption

string

Form of payment

asOfDate

string

Date benefit was calculated

frequency

string

ANNUALLYBIWEEKLYDAILYMONTHLYSEMIANNUALLYSEMIMONTHLYWEEKLY

startDate

string

Assumed retirement date ‐ As of date amount is payable

equityGrants

array of objects

Provides equity grant information on Restricted Stock Units, Restricted Stock Awards, Stock Appreciation Right, Stock Options, Performance Awards, and Total Share Return Units

object

grantId

string

Unique identifier of grant

grantDate

string

Date grant was given

grantType

string

Type of grant

seqNum

number

grantPrice

number

Grant price

grantCurrencyCode

string

Indicates the currency of grant USD vs AUD vs EUR etc (for share awards, you will still get a USD)

quantityGranted

number

Number of options

quantityOutstanding

number

expirationDate

string

Date grant expires

vestings

array of objects

An array of equityGrant vestings. Provides the past, present, and future vesting schedule and percentages.

object

vestedQuantity

number

Vested quantity (Vested shares total qty of vesting tranche)

vestedValue

number

Vested balance at grant (aggregate of all vestings)

vestingDate

string

vestExpireDate

string

vestedStatus

string

depositAccount

balanceAsOf

string

As-of date of balances

openingDayBalance

number

Day's opening fund balance

availableBalance

number

Balance of funds available for use

interestYtd

number

YTD Interest

currentBalance

number

Balance of funds in account

loanAccount

balanceAsOf

string

As-of date of balances

escrowBalance

number

Escrow balance of loan

interestPaidYearToDate

number

Interest paid year to date

lastPaymentAmount

number

Last payment amount

lastPaymentDate

string

Last payment date

nextPaymentAmount

number

Amount of next payment

nextPaymentDate

string

Date of next payment

originalPrincipal

number

Original principal of loan

payOffAmount

number

Payoff amount

principalBalance

number

Principal balance of loan

locAccount

balanceAsOf

string

As-of date of balances

advancesApr

number

Advances APR

availableCash

number

Available cash

availableCredit

number

Available credit

cashAdvanceLimit

number

Cash advance limit

creditLine

number

Credit limit

currentBalance

number

Current balance LOC

currentRewardsBalance

number

Current rewards balance

financeCharges

number

Finance charges

lastPaymentAmount

number

Last payment amount

lastPaymentDate

string

Last payment date

lastStmtBalance

number

Last Statement Balance

lastStmtDate

string

Last Statement Date

minimumPaymentAmount

number

Minimum payment amount

nextPaymentAmount

number

Amount of next payment

nextPaymentDate

string

Due date of next payment

pastDueAmount

number

Past Due Amount

pointsAccrued

number

Points accrued

principalBalance

number

Principal balance

pointsRedeemed

number

Points redeemed

purchasesApr

number

Purchases APR

insuranceAccount

policyCoverageAmount

number

Total amount of money the user is insured for.

policyEndDate

string

The premium end date.

policyPremium

number

The amount of the user's premium.

policyPremiumTerm

string

he payment term for the premium. MONTHLY or ANNUAL.

MONTHLYANNUAL

policyStartDate

string

The premium start date.

annuityAccount

annualIncrease

number

Percent or dollar amount of annual payment increase

annualIncreaseType

string

FIXEDPERCENTDOLLAR

netPresentValue

number

Surrender or cash balance value

paymentAmount

number

Amount of the recurring payment

paymentEndDate

string

Date last payment will be made

paymentStartDate

string

Date of first payment; could be a future date

periodCertainGuarantee

string

NO PERIOD CERTAIN5-YEAR10-YEAR20-YEAR30-YEAR

totalPaymentCount

number

Total number of payments that will be produced by the annuity

object

accounts

array of objects

An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)

Any of:

depositAccount

balanceAsOf

string

As-of date of balances

openingDayBalance

number

Day's opening fund balance

availableBalance

number

Balance of funds available for use

interestYtd

number

YTD Interest

currentBalance

number

Balance of funds in account

loanAccount

balanceAsOf

string

As-of date of balances

escrowBalance

number

Escrow balance of loan

interestPaidYearToDate

number

Interest paid year to date

lastPaymentAmount

number

Last payment amount

lastPaymentDate

string

Last payment date

nextPaymentAmount

number

Amount of next payment

nextPaymentDate

string

Date of next payment

originalPrincipal

number

Original principal of loan

payOffAmount

number

Payoff amount

principalBalance

number

Principal balance of loan

locAccount

balanceAsOf

string

As-of date of balances

advancesApr

number

Advances APR

availableCash

number

Available cash

availableCredit

number

Available credit

cashAdvanceLimit

number

Cash advance limit

creditLine

number

Credit limit

currentBalance

number

Current balance LOC

currentRewardsBalance

number

Current rewards balance

financeCharges

number

Finance charges

lastPaymentAmount

number

Last payment amount

lastPaymentDate

string

Last payment date

lastStmtBalance

number

Last Statement Balance

lastStmtDate

string

Last Statement Date

minimumPaymentAmount

number

Minimum payment amount

nextPaymentAmount

number

Amount of next payment

nextPaymentDate

string

Due date of next payment

pastDueAmount

number

Past Due Amount

pointsAccrued

number

Points accrued

principalBalance

number

Principal balance

pointsRedeemed

number

Points redeemed

purchasesApr

number

Purchases APR

investmentAccount

availableCashBalance

number

Cash balance across all sub-accounts. Should include sweep funds.

balanceAsOf

string

As-of date of balances

balanceList

array of objects

Balance List. Name value pair aggregate.

object

balanceName

string

Name of the balance.

balanceDescription

string

Description of balance.

balanceType

string

The type of an investment balance. AMOUNT or PERCENTAGE.

AMOUNTPERCENTAGE

balanceValue

number

Value of balance name.

balanceDate

string

Date as of this balance.

currency

object

currencyCode

string

Iso 4217 currency code.

currencyRate

number

Currency rate between original and converted currency.

originalCurrencyCode

string

Iso 4217 currency code.

currentValue

number

Total current value of all investments

dailyChange

number

Daily change

marginBalance

number

Margin balance

percentageChange

number

Percentage change

rolloverAmount

number

Rollover amount

shortBalance

number

Short balance

insuranceAccount

policyCoverageAmount

number

Total amount of money the user is insured for.

policyEndDate

string

The premium end date.

policyPremium

number

The amount of the user's premium.

policyPremiumTerm

string

he payment term for the premium. MONTHLY or ANNUAL.

MONTHLYANNUAL

policyStartDate

string

The premium start date.

annuityAccount

annualIncrease

number

Percent or dollar amount of annual payment increase

annualIncreaseType

string

FIXEDPERCENTDOLLAR

netPresentValue

number

Surrender or cash balance value

paymentAmount

number

Amount of the recurring payment

paymentEndDate

string

Date last payment will be made

paymentStartDate

string

Date of first payment; could be a future date

periodCertainGuarantee

string

NO PERIOD CERTAIN5-YEAR10-YEAR20-YEAR30-YEAR

totalPaymentCount

number

Total number of payments that will be produced by the annuity

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

string

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

object

code

integer

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

message

string

End user displayable information which might help the customer diagnose an error

debugMessage

string

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.