Mikomo model response

Last updated: May 25, 2021

Lightweight

{
  "accounts": [
    {
      "investmentAccount": {
        "accountId": "string",
        "accountNumber": "string",
        "accountType": "string",
        "description": "string",
        "displayName": "string",
        "nickname": "string"
      }
    }
  ]
}

Properties

Name	Type	Description
accounts	[any]
» investmentAccount	object
»» accountId	string
»» accountNumber	string
»» accountType	string
»» description	string
»» displayName	string
»» nickname	string

Account-Details

{
  "accounts": [
    {
      "investmentAccount": {
        "accountNumber": "string",
        "accountId": "string",
        "accountType": "string",
        "displayName": "string",
        "nickname": "string",
        "balanceAsOf": "2019-08-24T14:15:22Z",
        "currentValue": 0,
        "availableCashBalance": 0,
        "currency": {
          "currencyRate": 0,
          "currencyCode": "string",
          "originalCurrencyCode": "string"
        },
        "balanceType": "string",
        "marginBalance": 0,
        "holdings": [
          {
            "averageCost": true,
            "cashAccount": true,
            "currentUnitPrice": 0,
            "fiAttributes": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "marketValue": 0,
            "positionType": "string",
            "purchasedPrice": 0,
            "securityId": "string",
            "securityIdType": "string",
            "symbol": "string",
            "units": 0
          }
        ],
        "transactions": [
          {
            "accountId": "string",
            "amount": 0,
            "category": "string",
            "commission": 0,
            "description": "string",
            "fees": 0,
            "postedTimestamp": "2019-08-24T14:15:22Z",
            "price": 0,
            "securityId": "string",
            "securityIdType": "string",
            "securityType": "string",
            "shares": 0,
            "status": "string",
            "subCategory": "string",
            "symbol": "string",
            "transactionId": "string",
            "transactionTimestamp": "2019-08-24T14:15:22Z",
            "unitPrice": 0
          }
        ],
        "contributions": [
          null
        ]
      }
    }
  ]
}

Properties

Name	Type	Description
accounts	[object]
» investmentAccount	object
»» accountNumber	string
»» accountId	string
»» accountType	string
»» displayName	string
»» nickname	string
»» balanceAsOf	string(date-time)
»» currentValue	number
»» availableCashBalance	number
»» currency	object
»»» currencyRate	number
»»» currencyCode	string
»»» originalCurrencyCode	string
»» balanceType	string
»» marginBalance	number
»» holdings	[Holding]	Array of holdings
»» transactions	[InvestmentTransaction]	Array of Investment Transactions
»» contributions	[any]	Describes how new contributions are distributed among the available securities

InvestmentTransaction

{
  "accountId": "string",
  "amount": 0,
  "category": "string",
  "commission": 0,
  "description": "string",
  "fees": 0,
  "postedTimestamp": "2019-08-24T14:15:22Z",
  "price": 0,
  "securityId": "string",
  "securityIdType": "string",
  "securityType": "string",
  "shares": 0,
  "status": "string",
  "subCategory": "string",
  "symbol": "string",
  "transactionId": "string",
  "transactionTimestamp": "2019-08-24T14:15:22Z",
  "unitPrice": 0
}

Properties

Name	Type	Description
accountId	string
amount	number
category	string
commission	number
description	string
fees	number
postedTimestamp	string(date-time)
price	number
securityId	string
securityIdType	string
securityType	string
shares	number
status	string
subCategory	string
symbol	string	Ticker / Market symbol
transactionId	string
transactionTimestamp	string(date-time)
unitPrice	number

FiAttribute

{
  "name": "string",
  "value": "string"
}

FiAttribute Entity

Properties

Name	Type	Description
name	string	Name of attribute
value	string	Value of attribute

Holding

{
  "averageCost": true,
  "cashAccount": true,
  "currentUnitPrice": 0,
  "fiAttributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "marketValue": 0,
  "positionType": "string",
  "purchasedPrice": 0,
  "securityId": "string",
  "securityIdType": "string",
  "symbol": "string",
  "units": 0
}

Properties

Name	Type	Description
averageCost	boolean
cashAccount	boolean
currentUnitPrice	number
fiAttributes	[FiAttribute]	[Data provider-specific attribute]
marketValue	number
positionType	string
purchasedPrice	number
securityId	string
securityIdType	string
symbol	string	Ticker / Market symbol
units	number