Breakdown of Response Fields.

Institution

The identifying information of the institution that you’re connecting to in order to retrieve investment data.

Name

Description

Schema

Name

Name of the Institution.

string

Id

Unique identifier for the institution within the Flinks system.

string

Accounts

(See Below)

Account

A single institution may have one or many accounts contained within it to it. The fields within this object give an understanding of the overall state of that particular account at a given period of time.

Name

Description

Schema

Id

A unique identifier for the investment account within the Flinks system.

string

FullAccountId

Full Account information (as presented by the Financial Institution) associated with this specific investment account. Normally includes Name of Account, AccountId and Currency.

string

AccountId

Cleansed Account ID/Number that is associated with this specific investment account, can be used for account transfer purposes.

string

Name

Name of the investment.

string

Type

The investment account type.

An Investment may be reported as type "unknown" for some special investments accounts offered by the institution, or when the institution doesn’t provide sufficient information for the type to be reliably determined.

enum (cash, chequing, tfsa, rrsp, resp, rdsp, margin, short, long, lira, lrsp, rlsp, rrif, lif, lrif, prif, rpp, ipp, dpsp, spp, ndcp, nrsp, epsp, espp, esop, vrsp, unknown)

Registered

Whether or not this is a registered account.

boolean

Currency

The investment account settlement currency.

enum (aud, btc, cad, chf, cny, dkk, eur, gbp, hkd, inr, jpy, mxn, nok, nzd, sek, sgd, twd, usd, vnd)

Cash

The amount of cash in the investment account, in the account settlement currency.

decimal

AccountValue

The value of the account including the cash and securities at market value.

decimal

CurrencyValue

The value of the account in the account $ including the cash and securities at market value.

decimal

Positions

See Below

Transactions

See Below

Positions

The positions show the composition of the individual securities (types of investment products) within each account and how those securities have changed in value over time.

Name

Description

Schema

Id

A unique identifier for the position within the Flinks system.

string

Category

The position category.

string

Class

The position class.

enum (equity, fixed_income, cash_equivalent, tangible_asset, other)

BookValue

The book value of the position (the acquisition price).

decimal

Quantity

The quantity of the security in the position.

decimal

MarketValue

The market value of the position, in the security’s currency.

decimal

GainAmount

The current gain amount of the position, in the security’s currency.

decimal

GainCurrencyAmount

The current gain amount in the account $ of the position, in the security’s currency.

decimal

GainPercent

The current gain percent of the position.

decimal

Currency

The investment account currency.

decimal

SecuirtId

See Below

string

Transactions

The transactions object contains a series of actions and events that occurred in order to construct the portfolio. You can think of this as an activity log or the story of how your end user got to where they are today.

Name

Description

Schema

Id

ID of the transaction within the Flinks system.

string

Date

The date when the transaction occurred.

timestamp

Type

The transaction type.
(deposit, withdrawal, transfer, interest, dividend, distribution, roc, reinvest, tax, fee, sell, buy, income, unknown)

enum

Description

The transaction description. This is taken from the institution’s website.

string

Amount

The transaction amount, converted to the account settlement currency.

decimal

Quantity

The quantity of securities involved in the transaction.

decimal

Security

Related Security Object.

Security

The security object contains descriptive information about the underlying asset of the portfolio.

Name

Description

Schema

Id

ID of the security within the Flinks System.

string

ISIN

A 12 character globally unique securities identifier.

string (will be returned as null if we are unable to accurately match to the security)

CUSIP

A 9 character identifier to North American Securities.

string (will be returned as null if we are unable to accurately match to the security)

Price

The price of the security at the date associated.

decimal

Date

The date and time the price was updated.

decimal and date

Type

The security type.

string

Symbol

Ticker of the security.

string

Aliases

Alternative names for the security.

string