BetterWealth API API Reference

BetterWealth Admin API

API Endpoint
http://http://test.local/
Terms of Service: Terms of service
Contact: api@betterwealth.se
Version: API 0.1

admin-asset-cache-resource

Admin Asset Cache Resource

admin-asset-cache-resource

getAssetCacheStatus

POST /v2/admin/asset-cache

assetIds

string
Request Content-Types: application/json
Request Example
[
  "string"
]
200 OK
InternalAssetCacheStatusRepresentation

Cache status for assets

type
InternalAssetCacheStatusRepresentation
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "assetId": "string",
    "historyStatus": {
      "firstUpdate": "integer (int64)",
      "lastUpdate": "integer (int64)",
      "status": "string"
    },
    "periodHistoryStatus": {
      "lastUpdate": "integer (int64)",
      "status": "string"
    },
    "valueStatus": {
      "lastUpdate": "integer (int64)",
      "status": "string"
    }
  }
]
admin-asset-cache-resource

uploadDBCurrency

POST /v2/admin/asset-cache/db-currency
CSVDataContainer

data

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
CSVDataUploadResponse

CSV response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

uploadECBCurrency

POST /v2/admin/asset-cache/ecb-currency

data

DaySeriesEntry
baseCurrency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
in query

baseCurrency

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
in query

currency

Request Content-Types: application/json
Request Example
[
  {
    "timestamp": "integer (int64)",
    "value": "number (double)"
  }
]
200 OK
CSVDataUploadResponse

CSV response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

exportHistoryCsv

GET /v2/admin/asset-cache/export/history
ticker: string
in query

ticker

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
in query

currency

200 OK

Stream of CSV data

type
string
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
"string"
admin-asset-cache-resource

getAssetHistoryUploadRequests

GET /v2/admin/asset-cache/history
200 OK
CSVDataUploadResponse

Get list of assets that require a history update

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

uploadAssetHistory

POST /v2/admin/asset-cache/history
CSVDataContainer

data

skipHistoryUpdatedEvent: boolean false
in query

skipHistoryUpdatedEvent

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
CSVDataUploadResponse

CSV response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

uploadAssetHistoryReplacement

POST /v2/admin/asset-cache/history/replace
CSVDataContainer

data

skipHistoryUpdatedEvent: boolean false
in query

skipHistoryUpdatedEvent

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
CSVDataUploadResponse

CSV response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

getAssetValueUploadRequests

GET /v2/admin/asset-cache/value
200 OK
CSVDataUploadResponse

Get list of assets that require a value update

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

uploadAssetValue

POST /v2/admin/asset-cache/value
CSVDataContainer

data

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
CSVDataUploadResponse

CSV response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

uploadAssetPeriodValue

POST /v2/admin/asset-cache/value/period
AssetPeriodValueUpdate

data

Request Content-Types: application/json
Request Example
{
  "currency": "string",
  "fiveYears": "number (double)",
  "oneMonth": "number (double)",
  "oneYear": "number (double)",
  "sixMonths": "number (double)",
  "thisYear": "number (double)",
  "threeMonths": "number (double)",
  "threeYears": "number (double)",
  "ticker": "string",
  "updated": "string"
}
200 OK
GenericResponse

A generic response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-asset-cache-resource

uploadAssetValueReplacement

POST /v2/admin/asset-cache/value/replace
CSVDataContainer

data

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
CSVDataUploadResponse

CSV response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "records": "integer (int32)",
  "success": "boolean"
}
admin-asset-cache-resource

getAssetCacheStatus

GET /v2/admin/asset-cache/{assetId}
assetId: string
in path

assetId

200 OK
InternalAssetCacheStatusRepresentation

Cache status for asset

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "assetId": "string",
  "historyStatus": {
    "firstUpdate": "integer (int64)",
    "lastUpdate": "integer (int64)",
    "status": "string"
  },
  "periodHistoryStatus": {
    "lastUpdate": "integer (int64)",
    "status": "string"
  },
  "valueStatus": {
    "lastUpdate": "integer (int64)",
    "status": "string"
  }
}

admin-tax-report-resource

Admin Tax Report Resource

admin-tax-report-resource

getISKData

GET /v2/admin/tax-reports/isk/{year}
year: integer (int32)
in path

year

clientId: string
in query

clientId

generationMethod: string GENERATE, LOG_REPORT, REPORT_FROM_LOG false
in query

generationMethod

200 OK
InputStreamResource

An ISK report file, json formatted

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-tax-report-resource

getISKXMLReport

POST /v2/admin/tax-reports/isk/{year}/xml
TaxReportMeta

reportMeta

year: integer (int32)
in path

year

clientId: string
in query

clientId

generationMethod: string GENERATE, LOG_REPORT, REPORT_FROM_LOG false
in query

generationMethod

Request Content-Types: application/json
Request Example
{
  "contactPerson": {
    "email": "string",
    "name": "string",
    "phone": "string"
  },
  "organisationNumber": "string",
  "techContactPerson": {
    "email": "string",
    "name": "string",
    "phone": "string"
  }
}
200 OK
InputStreamResource

An ISK tax report file, xml formatted

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-tax-report-resource

getSalesTaxReport

GET /v2/admin/tax-reports/sales/{userId}/{year}
userId: string
in path

userId

year: integer (int32)
in path

year

startDate: string
in query

startDate

logReports: boolean false
in query

logReports

200 OK
InputStreamResource

An Sales tax report file, csv formatted

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-tax-report-resource

getSalesTaxXMLReport

POST /v2/admin/tax-reports/sales/{userId}/{year}/xml
TaxReportMeta

reportMeta

userId: string
in path

userId

year: integer (int32)
in path

year

startDate: string
in query

startDate

logReports: boolean false
in query

logReports

Request Content-Types: application/json
Request Example
{
  "contactPerson": {
    "email": "string",
    "name": "string",
    "phone": "string"
  },
  "organisationNumber": "string",
  "techContactPerson": {
    "email": "string",
    "name": "string",
    "phone": "string"
  }
}
200 OK
InputStreamResource

An Sales tax report file, csv formatted

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}

admin-asset-storage-resource

Admin Asset Storage Resource

admin-asset-storage-resource

getAssetStorage

GET /v2/admin/asset-storage
200 OK
InternalAssetStorageItemRepresentation

Asset storage items

type
InternalAssetStorageItemRepresentation
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "assetId": "string",
    "id": "string"
  }
]
admin-asset-storage-resource

addCheckpoint

POST /v2/admin/asset-storage/checkpoint
BalanceCheckpoint

body

Request Content-Types: application/json
Request Example
{
  "balanceDate": "string",
  "checkBalanceTargetValue": "object"
}
200 OK
AdminLogEntry

Log entry describing the created checkpoint

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}
admin-asset-storage-resource

depositToAssetStorage

POST /v2/admin/asset-storage/deposit
AssetStorageDepositRepresentation

body

Request Content-Types: application/json
Request Example
{
  "absChangeOnly": "boolean",
  "amount": "number (double)",
  "currency": "string",
  "message": "string"
}
200 OK
InternalAssetStorageItemRepresentation

The updated asset storage item

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "assetId": "string",
  "id": "string"
}
admin-asset-storage-resource

getDepositLog

GET /v2/admin/asset-storage/log
page: integer (int32)
in query

page

sortOrder: string DESC, ASC
in query

sortOrder

200 OK
InternalPageRepresentationAdminLogEntry

Page of deposit log entries

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-asset-storage-resource

getTotalPortfolioBalance

GET /v2/admin/asset-storage/portfolio-balance
200 OK
InternalAssetStorageItemRepresentation

Get the total balance of all portfolios

type
InternalAssetStorageItemRepresentation
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "assetId": "string",
    "id": "string"
  }
]

admin-action-code-admin-resource

Admin Action Code Admin Resource

admin-action-code-admin-resource

getCodes

GET /v2/admin/action-codes
type: string
in query

type

pageToken: string
in query

pageToken

200 OK
TokenizedPageActionCodeActionCodeWithUrl

A page of action codes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "activationUrl": "string",
      "activatorAction": "string",
      "activatorActionProps": {
        "initialValue": "number (double)"
      },
      "created": "string",
      "description": "string",
      "expiration": "string",
      "id": "string",
      "issuer": "string",
      "issuerAction": "string",
      "issuerActionCondition": "string",
      "issuerActionConditionProps": "object",
      "issuerActionProps": {
        "initialValue": "number (double)"
      },
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-action-code-admin-resource

createCode

POST /v2/admin/action-codes
ActionCode

data

Request Content-Types: application/json
Request Example
{
  "activatorAction": "string",
  "activatorActionProps": {
    "initialValue": "number (double)"
  },
  "created": "string",
  "description": "string",
  "expiration": "string",
  "id": "string",
  "issuer": "string",
  "issuerAction": "string",
  "issuerActionCondition": "string",
  "issuerActionConditionProps": "object",
  "issuerActionProps": {
    "initialValue": "number (double)"
  },
  "name": "string",
  "type": "string"
}
200 OK
ActionCodeWithUrl

An action code

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activationUrl": "string",
  "activatorAction": "string",
  "activatorActionProps": {
    "initialValue": "number (double)"
  },
  "created": "string",
  "description": "string",
  "expiration": "string",
  "id": "string",
  "issuer": "string",
  "issuerAction": "string",
  "issuerActionCondition": "string",
  "issuerActionConditionProps": "object",
  "issuerActionProps": {
    "initialValue": "number (double)"
  },
  "name": "string",
  "type": "string"
}
admin-action-code-admin-resource

activateCodeForUser

POST /v2/admin/action-codes/activate/{code}/{id}
code: string
in path

code

id: string
in path

id

200 OK
ActionCodeActivation

An action code activation

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activationDate": "string",
  "activator": "string",
  "activatorValue": "number (double)",
  "code": {
    "activatorAction": "string",
    "activatorActionProps": {
      "initialValue": "number (double)"
    },
    "created": "string",
    "description": "string",
    "expiration": "string",
    "id": "string",
    "issuer": "string",
    "issuerAction": "string",
    "issuerActionCondition": "string",
    "issuerActionConditionProps": "object",
    "issuerActionProps": {
      "initialValue": "number (double)"
    },
    "name": "string",
    "type": "string"
  },
  "id": "string",
  "issuerActivationDate": "string",
  "issuerValue": "number (double)"
}
admin-action-code-admin-resource

getActivationsForCode

GET /v2/admin/action-codes/activations/code/{id}
id: string
in path

id

pageToken: string
in query

pageToken

200 OK
TokenizedPageActionCodeActivation

A page of action code activations

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "activationDate": "string",
      "activator": "string",
      "activatorValue": "number (double)",
      "code": {
        "activatorAction": "string",
        "activatorActionProps": {
          "initialValue": "number (double)"
        },
        "created": "string",
        "description": "string",
        "expiration": "string",
        "id": "string",
        "issuer": "string",
        "issuerAction": "string",
        "issuerActionCondition": "string",
        "issuerActionConditionProps": "object",
        "issuerActionProps": {
          "initialValue": "number (double)"
        },
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "issuerActivationDate": "string",
      "issuerValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-action-code-admin-resource

getActivationsForUser

GET /v2/admin/action-codes/activations/issuer/{id}
id: string
in path

id

pageToken: string
in query

pageToken

200 OK
TokenizedPageActionCodeActivationExternal

A page of action code user activations

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "action": "string",
      "actionProps": {
        "initialValue": "number (double)"
      },
      "activated": "string",
      "codeId": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "role": "string",
      "type": "string",
      "value": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-action-code-admin-resource

getCode

GET /v2/admin/action-codes/code/{name}
name: string
in path

name

200 OK
ActionCodeWithUrl

An action code

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activationUrl": "string",
  "activatorAction": "string",
  "activatorActionProps": {
    "initialValue": "number (double)"
  },
  "created": "string",
  "description": "string",
  "expiration": "string",
  "id": "string",
  "issuer": "string",
  "issuerAction": "string",
  "issuerActionCondition": "string",
  "issuerActionConditionProps": "object",
  "issuerActionProps": {
    "initialValue": "number (double)"
  },
  "name": "string",
  "type": "string"
}
admin-action-code-admin-resource

getCodesForIssuer

GET /v2/admin/action-codes/issuer/{id}
id: string
in path

id

type: string
in query

type

pageToken: string
in query

pageToken

200 OK
TokenizedPageActionCodeActionCodeWithUrl

A page of action codes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "activationUrl": "string",
      "activatorAction": "string",
      "activatorActionProps": {
        "initialValue": "number (double)"
      },
      "created": "string",
      "description": "string",
      "expiration": "string",
      "id": "string",
      "issuer": "string",
      "issuerAction": "string",
      "issuerActionCondition": "string",
      "issuerActionConditionProps": "object",
      "issuerActionProps": {
        "initialValue": "number (double)"
      },
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-action-code-admin-resource

getCode

GET /v2/admin/action-codes/{id}
id: string
in path

id

200 OK
ActionCodeWithUrl

An action code

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activationUrl": "string",
  "activatorAction": "string",
  "activatorActionProps": {
    "initialValue": "number (double)"
  },
  "created": "string",
  "description": "string",
  "expiration": "string",
  "id": "string",
  "issuer": "string",
  "issuerAction": "string",
  "issuerActionCondition": "string",
  "issuerActionConditionProps": "object",
  "issuerActionProps": {
    "initialValue": "number (double)"
  },
  "name": "string",
  "type": "string"
}

admin-customer-resource

Admin Customer Resource

admin-customer-resource

list

GET /v2/admin/customers
riskCategory: string
in query

riskCategory

clientId: string
in query

clientId

organizations: string
in query

organizations

minAum: integer (int32)
in query

minAum

maxAum: integer (int32)
in query

maxAum

minAge: integer (int32)
in query

minAge

maxAge: integer (int32)
in query

maxAge

notifications: boolean
in query

notifications

newsletter: boolean
in query

newsletter

source: string
in query

source

sortField: string CREATED, AUM, INVESTED, WITHDRAWN
in query

sortField

sortOrder: string DESC, ASC
in query

sortOrder

pageToken: string
in query

pageToken

200 OK
TokenizedPageUserWithValue

Page of users

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "investedValue": "number (double)",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "organizationsCount": "number (double)",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "totalValue": "number (double)",
      "userProfileAlias": "string",
      "uuid": "string",
      "withdrawnValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

listUsers

POST /v2/admin/customers
UserFilter

filter

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "assetAmount": {
    "assetId": "string",
    "minAmount": "number (double)"
  },
  "clientId": "string",
  "maxAge": "integer (int32)",
  "maxAum": "integer (int32)",
  "minAge": "integer (int32)",
  "minAum": "integer (int32)",
  "newsletter": "boolean",
  "notifications": "boolean",
  "organizationFilter": "string",
  "riskCategory": "string",
  "sortField": "string",
  "sortOrder": "string",
  "sourceCode": "string",
  "valueSource": {
    "templateId": "string",
    "templateOwnerId": "string"
  }
}
200 OK
TokenizedPageUserWithValue

Page of users

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "investedValue": "number (double)",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "organizationsCount": "number (double)",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "totalValue": "number (double)",
      "userProfileAlias": "string",
      "uuid": "string",
      "withdrawnValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

list

GET /v2/admin/customers/contact/{contactId}
contactId: string
in path

contactId

pageToken: string
in query

pageToken

200 OK
TokenizedPageUserWithValue

Page of users

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "investedValue": "number (double)",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "organizationsCount": "number (double)",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "totalValue": "number (double)",
      "userProfileAlias": "string",
      "uuid": "string",
      "withdrawnValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

export

GET /v2/admin/customers/export
riskCategory: string
in query

riskCategory

clientId: string
in query

clientId

organizations: string
in query

organizations

minAum: integer (int32)
in query

minAum

maxAum: integer (int32)
in query

maxAum

minAge: integer (int32)
in query

minAge

maxAge: integer (int32)
in query

maxAge

notifications: boolean
in query

notifications

newsletter: boolean
in query

newsletter

source: string
in query

source

sortField: string CREATED, AUM, INVESTED, WITHDRAWN
in query

sortField

sortOrder: string DESC, ASC
in query

sortOrder

fields: string[] NAME, EMAIL
in query

fields

Array values passed as multiple parameters: ?fields=aaa&fields=bbb
200 OK
TokenizedPageUserWithValue

User csv date

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "investedValue": "number (double)",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "organizationsCount": "number (double)",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "totalValue": "number (double)",
      "userProfileAlias": "string",
      "uuid": "string",
      "withdrawnValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

exportUserKycFile

GET /v2/admin/customers/export/kyc
200 OK
InputStreamResource

User kyc data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-customer-resource

list

GET /v2/admin/customers/kyc
page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationUserWithKYC

Page of users with KYC

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "kyc": {
        "responseItems": [
          {
            "hitRating": "integer (int32)",
            "itemType": "string",
            "listType": "string",
            "name": "string",
            "sourceName": "string"
          }
        ]
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-customer-resource

getLeads

GET /v2/admin/customers/leads
deleted: string INCLUDE_DELETED, EXCLUDE_DELETED
in query

deleted

converted: string INCLUDE_CONVERTED, EXCLUDE_CONVERTED
in query

converted

pensionPlan: boolean
in query

pensionPlan

onboading: boolean
in query

onboading

pageToken: string
in query

pageToken

200 OK
TokenizedPageLead

List of leads

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "clientId": "string",
      "converted": "string",
      "created": "string",
      "email": "string",
      "id": "string",
      "name": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "onboarding": "boolean",
      "pensionPlan": "boolean",
      "phone": "string",
      "privacyPolicyAcceptVersion": "integer (int32)",
      "shortName": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

getPendingOrganizationDeletes

GET /v2/admin/customers/organizations/pending-delete
pageToken: string
in query

pageToken

200 OK
TokenizedPagePendingCustomerDeletion

Page of pending deletes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "createdTimestamp": "integer (int64)",
      "customerId": "string",
      "customerType": "string",
      "deleteTimestamp": "integer (int64)",
      "lastTransactionTimestamp": "integer (int64)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

listPensionUsers

GET /v2/admin/customers/pension
pageToken: string
in query

pageToken

200 OK
TokenizedPageUserWithPensionDetails

Page of users with pension data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

listPepUsers

GET /v2/admin/customers/pep
page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationUserWithKnowledge

Page of users with knowledge

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-customer-resource

search

GET /v2/admin/customers/search
q: string
in query

q

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
in query

clientId

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationUser

Page of users matching query

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "userProfileAlias": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-customer-resource

getPendingUserDeletes

GET /v2/admin/customers/user/pending-delete
pageToken: string
in query

pageToken

200 OK
TokenizedPagePendingCustomerDeletion

Page of pending deletes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "createdTimestamp": "integer (int64)",
      "customerId": "string",
      "customerType": "string",
      "deleteTimestamp": "integer (int64)",
      "lastTransactionTimestamp": "integer (int64)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

getBankAccountsForUser

GET /v2/admin/customers/{userId}/bank-accounts
userId: string
in path

userId

200 OK
BankAccount

List of bank accounts

type
BankAccount
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  }
]
admin-customer-resource

getOrganizationsForUser

GET /v2/admin/customers/{userId}/organizations
userId: string
in path

userId

200 OK
OrganizationListItem

List of organization objects

type
OrganizationListItem
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "clientId": "string",
    "created": "string",
    "email": "string",
    "lei": "string",
    "name": "string",
    "organizationNumber": {
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string",
      "vatnumber": "string"
    },
    "principal": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    },
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "status": "string",
    "uuid": "string"
  }
]
admin-customer-resource

getRecurringTransactions

GET /v2/admin/customers/{userId}/recurring-transactions
userId: string
in path

userId

200 OK
RecurringTransaction

List of recurring transactions

type
RecurringTransaction
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "bankAccountId": "string",
    "created": "string",
    "paused": "boolean",
    "portfolioIndex": "integer (int32)",
    "protocol": "string",
    "status": "string",
    "transactionDay": "integer (int32)",
    "type": "string",
    "userUuid": "string",
    "uuid": "string"
  }
]
admin-customer-resource

triggerRecurringTransaction

POST /v2/admin/customers/{userId}/recurring-transactions/{transactionId}/trigger
userId: string
in path

userId

transactionId: string
in path

transactionId

200 OK
RecurringTransaction

List of recurring transactions

type
RecurringTransaction
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "bankAccountId": "string",
    "created": "string",
    "paused": "boolean",
    "portfolioIndex": "integer (int32)",
    "protocol": "string",
    "status": "string",
    "transactionDay": "integer (int32)",
    "type": "string",
    "userUuid": "string",
    "uuid": "string"
  }
]
admin-customer-resource

getValidUser

GET /v2/admin/customers/{userUuid}
userUuid: string
in path

userUuid

200 OK
UserWithRoles

User data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authRoles": [
    "string"
  ],
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "features": [
    "string"
  ],
  "firstName": "string",
  "idProvider": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "userProfileAlias": "string",
  "uuid": "string"
}
admin-customer-resource

delete

DELETE /v2/admin/customers/{userUuid}
userUuid: string
in path

userUuid

200 OK
CustomerDeleteResponse

Delete response

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "customerId": "string",
  "status": "string"
}
admin-customer-resource

getCustomerAdvice

GET /v2/admin/customers/{userUuid}/advice
userUuid: string
in path

userUuid

200 OK
CustomerAdvice

Customer advice

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adviceMaterial": {
    "accountType": "string",
    "age": "integer (int32)",
    "bearLoss": "string",
    "income": "integer (int32)",
    "monthlyInvestment": "integer (int32)",
    "sri": "boolean",
    "startInvestment": "integer (int32)",
    "strategy": "string",
    "timeHorizon": "integer (int32)"
  },
  "portfolios": [
    {
      "accountType": "string",
      "customTemplateSelection": {
        "type": "string"
      },
      "endDate": "string",
      "goalAmount": "number (double)",
      "initialDeposit": "number (double)",
      "investmentPurpose": "string",
      "investmentStrategyType": "string",
      "lossAbility": "string",
      "monthlyDeposit": "number (double)",
      "monthlyPayout": "number (double)",
      "name": "string",
      "parent": "boolean",
      "parentUuid": "string",
      "payoutEndDate": "string",
      "riskLevel": "string",
      "sri": "boolean",
      "uuid": "string"
    }
  ],
  "timestamp": "integer (int64)"
}
admin-customer-resource

getCustomerKnowledge

GET /v2/admin/customers/{userUuid}/knowledge
userUuid: string
in path

userUuid

200 OK
UserKnowledgeInformation

Customer knowledge

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "customerKnowledge": {
    "cashSources": "object",
    "citizenship": [
      "string"
    ],
    "completedAcceptActions": [
      {
        "action": "string",
        "timestamp": "string",
        "version": "integer (int32)"
      }
    ],
    "completedKnowledgeTests": [
      {
        "completionDate": "string",
        "questions": [
          {
            "answerId": "string",
            "questionId": "string"
          }
        ],
        "type": "string",
        "version": "integer (int32)"
      }
    ],
    "depositPeriodicity": "string",
    "employment": "string",
    "funds": "boolean",
    "income": "number (double)",
    "investmentPurpose": "object",
    "investmentSize": "string",
    "liquidAssets": "string",
    "loansAndCredits": "boolean",
    "lossKnowledge": "boolean",
    "ownage": "boolean",
    "pep": "string",
    "pepPosition": "string",
    "pepRelation": "string",
    "pepRelationPosition": "string",
    "privacyPolicyAccept": {
      "updated": "string",
      "value": "boolean"
    },
    "taxResidence": "string",
    "taxResidenceSweden": "boolean",
    "tin": "string",
    "transferSource": "string",
    "unrealizedLiquidAssets": "string",
    "version": "integer (int32)",
    "withdrawalPeriodicity": "string"
  },
  "lastUpdated": "string"
}
admin-customer-resource

patchCustomerKnowledge

PATCH /v2/admin/customers/{userUuid}/knowledge
UserKnowledgeAdminPatch

patch

userUuid: string
in path

userUuid

Request Content-Types: application/json
Request Example
{
  "pep": {
    "action": "string",
    "value": "string"
  },
  "pepPosition": {
    "action": "string",
    "value": "string"
  },
  "pepRelation": {
    "action": "string",
    "value": "string"
  },
  "pepRelationPosition": {
    "action": "string",
    "value": "string"
  },
  "taxResidence": {
    "action": "string",
    "value": "string"
  },
  "taxResidenceSweden": {
    "action": "string",
    "value": "boolean"
  },
  "tin": {
    "action": "string",
    "value": "string"
  }
}
200 OK
UserKnowledgeInformation

Customer knowledge data

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "customerKnowledge": {
    "cashSources": "object",
    "citizenship": [
      "string"
    ],
    "completedAcceptActions": [
      {
        "action": "string",
        "timestamp": "string",
        "version": "integer (int32)"
      }
    ],
    "completedKnowledgeTests": [
      {
        "completionDate": "string",
        "questions": [
          {
            "answerId": "string",
            "questionId": "string"
          }
        ],
        "type": "string",
        "version": "integer (int32)"
      }
    ],
    "depositPeriodicity": "string",
    "employment": "string",
    "funds": "boolean",
    "income": "number (double)",
    "investmentPurpose": "object",
    "investmentSize": "string",
    "liquidAssets": "string",
    "loansAndCredits": "boolean",
    "lossKnowledge": "boolean",
    "ownage": "boolean",
    "pep": "string",
    "pepPosition": "string",
    "pepRelation": "string",
    "pepRelationPosition": "string",
    "privacyPolicyAccept": {
      "updated": "string",
      "value": "boolean"
    },
    "taxResidence": "string",
    "taxResidenceSweden": "boolean",
    "tin": "string",
    "transferSource": "string",
    "unrealizedLiquidAssets": "string",
    "version": "integer (int32)",
    "withdrawalPeriodicity": "string"
  },
  "lastUpdated": "string"
}
admin-customer-resource

getCustomerKYCData

GET /v2/admin/customers/{userUuid}/kyc
userUuid: string
in path

userUuid

200 OK
UserKYC

Customer KYC data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "responseItems": [
    {
      "hitRating": "integer (int32)",
      "itemType": "string",
      "listType": "string",
      "name": "string",
      "sourceName": "string"
    }
  ]
}
admin-customer-resource

getUserLog

GET /v2/admin/customers/{userUuid}/log
userUuid: string
in path

userUuid

types: string[] USER_CREATE, USER_LOGIN, USER_LOGIN_ORGANIZATION, USER_SIGN, ADMIN_VIEW_USER_LOGIN, ADMIN_VIEW_ORGANIZATION_LOGIN, USER_RECURRING_TRANSACTION_CANCELED, USER_RECURRING_TRANSACTION_ACTIVATED, USER_AUTOGIRO_CANCELED, USER_AUTOGIRO_ACTIVATED, USER_RECURRING_TRANSACTION_CREATED, USER_RECURRING_TRANSACTION_UPDATED, USER_RECURRING_TRANSACTION_DELETED, USER_DELETE, KNOWLEDGE_UPDATED, USER_UPDATED, USER_MIGRATED, ORGANIZATION_DELETE, ORGANIZATION_CREATED, ORGANIZATION_UPDATED, ORGANIZATION_ROLE_UPDATED, ORGANIZATION_KNOWLEDGE_UPDATED, SALES_TAX_REPORT
in query

types

Array values passed as multiple parameters: ?types=aaa&types=bbb
page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationCustomerLogEntry

Page of user log

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerLogEntryType": "string",
      "customerUuid": "string",
      "payload": "object",
      "timestamp": "integer (int64)",
      "type": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-customer-resource

migrateUser

POST /v2/admin/customers/{userUuid}/migrate
userUuid: string
in path

userUuid

targetClient: string
in query

targetClient

200 OK
CompletableFuture«List«UserMigrationResultItem»»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-customer-resource

consolidateUser

POST /v2/admin/customers/{userUuid}/migrate/consolidate
userUuid: string
in path

userUuid

targetClient: string
in query

targetClient

200 OK
CompletableFuture«List«UserMigrationResultItem»»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-customer-resource

getPortfolioTradeOrdersForCustomer

POST /v2/admin/customers/{userUuid}/portfolio-trade-orders
PortfolioTradeOrderFilter

filter

customerId: string
in path

customerId

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "assetId": "string",
  "maxDate": "string",
  "minDate": "string",
  "orderState": [
    "string"
  ],
  "orderType": "string",
  "portfolioType": "string",
  "recurring": "string",
  "source": "string",
  "sourceType": "string",
  "target": "string",
  "targetType": "string"
}
200 OK
TokenizedPagePortfolioTradeOrder

Portfolio trade orders for customer

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "amount": "number (double)",
      "assets": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "tradeUnit": "string",
          "value": "number (double)"
        }
      ],
      "created": "string",
      "currency": "string",
      "id": "string",
      "marketOrderId": "string",
      "orderEstimates": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currencyExchangeFee": "number (double)",
          "currencyExchangeRate": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "price": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "tradeFee": "number (double)",
          "type": "string",
          "value": "number (double)"
        }
      ],
      "orderState": "string",
      "ownerId": "string",
      "portfolioId": "string",
      "recurringSource": "string",
      "simpleId": "integer (int32)",
      "sourceId": "string",
      "sourceType": "string",
      "targetId": "string",
      "targetType": "string",
      "tradeGroupId": "string",
      "tradeId": "string",
      "transactionDay": "integer (int32)",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-customer-resource

getPortfoliosForUser

GET /v2/admin/customers/{userUuid}/portfolios
userUuid: string
in path

userUuid

includeDeleted: boolean false
in query

includeDeleted

200 OK
PortfolioDataWithOwner

Portfolios for customer

type
PortfolioDataWithOwner
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "accountType": "string",
    "assets": [
      {
        "amount": "number (double)",
        "assetId": "string"
      }
    ],
    "bearLoss": "string",
    "deleted": "boolean",
    "endDate": "integer (int64)",
    "errors": [
      "string"
    ],
    "fee": {
      "fixedTradeFee": {
        "exchangeFee": "number (double)",
        "tradeFee": "number (double)"
      },
      "managementFee": "number (double)",
      "noValueBasedDiscount": "boolean",
      "safekeepingFee": "number (double)",
      "tradeFeesNotIncluded": "boolean",
      "valueBasedDiscount": "number (double)",
      "vat": "number (double)"
    },
    "feeDiscounts": [
      {
        "canceled": "string",
        "created": "string",
        "fee": {
          "fixedTradeFee": {
            "exchangeFee": "number (double)",
            "tradeFee": "number (double)"
          },
          "managementFee": "number (double)",
          "noValueBasedDiscount": "boolean",
          "safekeepingFee": "number (double)",
          "tradeFeesNotIncluded": "boolean",
          "valueBasedDiscount": "number (double)",
          "vat": "number (double)"
        },
        "id": "string",
        "periodEnd": "string",
        "periodStart": "string"
      }
    ],
    "goalAmount": "number (double)",
    "id": "string",
    "initialDeposit": "number (double)",
    "investmentPurpose": "string",
    "investmentStrategyType": "string",
    "lastUpdate": "integer (int64)",
    "monthlyDeposit": "number (double)",
    "monthlyPayout": "number (double)",
    "name": "string",
    "owner": {
      "ownerType": "string",
      "uuid": "string"
    },
    "ownerId": "string",
    "parent": "boolean",
    "parentId": "string",
    "payoutEndDate": "integer (int64)",
    "portfolioIndex": "integer (int32)",
    "riskLevel": "string",
    "sri": "boolean",
    "startDate": "integer (int64)",
    "state": {
      "depositBalance": "number (double)",
      "depositTriggers": [
        {
          "amount": "number (double)",
          "recurring": "boolean",
          "sourceId": "string",
          "triggerType": "string"
        }
      ],
      "feeWithdrawalBalance": "number (double)",
      "fullWithdrawal": "boolean",
      "hasError": "boolean",
      "pendingDeposit": "boolean",
      "pendingFeeWithdrawal": "boolean",
      "pendingRealloc": "boolean",
      "pendingTrade": "boolean",
      "pendingWithdrawal": "boolean",
      "reallocTriggerType": "string",
      "tradeGroupIdentifier": "string",
      "tradeSubState": "string",
      "withdrawalBalance": "number (double)"
    },
    "templatePortfolio": {
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "estimatedReturn": "number (double)",
      "id": "string",
      "lastDistributionChange": "integer (int64)",
      "lastDistributionRefresh": "integer (int64)",
      "maxDD": "number (double)",
      "name": "string",
      "strategyIndex": "string",
      "targetDistribution": {
        "alternative": "number (double)",
        "bonds": "number (double)",
        "commodities": "number (double)",
        "stocks": "number (double)"
      },
      "targetVar": "number (double)",
      "trackingPortfolio": "string",
      "type": "string",
      "var": "number (double)",
      "volatility": "number (double)"
    },
    "templatePortfolioActionStatus": "string",
    "wallpaper": {
      "id": "string",
      "protocol": "string"
    }
  }
]
admin-customer-resource

getUserProfile

GET /v2/admin/customers/{userUuid}/profile
userUuid: string
in path

userUuid

200 OK
UserProfile

Customer public profile

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "alias": "string",
  "description": "string",
  "facebookLink": "string",
  "id": "string",
  "instagramLink": "string",
  "linkedinLink": "string",
  "profilePicture": "string",
  "ticktockLink": "string",
  "topTraderData": {
    "aumFraction": "number (double)",
    "depositFraction": "number (double)",
    "enabled": "boolean",
    "payoutMethod": "string"
  },
  "userUuid": "string",
  "verified": "boolean"
}
admin-customer-resource

updateUserProfile

PATCH /v2/admin/customers/{userUuid}/profile
UserProfileAdminPatch

patch

userUuid: string
in path

userUuid

Request Content-Types: application/json
Request Example
{
  "facebookLink": {
    "action": "string",
    "value": "string"
  },
  "instagramLink": {
    "action": "string",
    "value": "string"
  },
  "linkedinLink": {
    "action": "string",
    "value": "string"
  },
  "profilePicture": {
    "action": "string",
    "value": "string"
  },
  "tikTokLink": {
    "action": "string",
    "value": "string"
  },
  "topTraderData": {
    "action": "string",
    "value": {
      "aumFraction": "number (double)",
      "depositFraction": "number (double)",
      "enabled": "boolean",
      "payoutMethod": "string"
    }
  },
  "verified": {
    "action": "string",
    "value": "boolean"
  }
}
200 OK
UserProfile

Customer public profile

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "alias": "string",
  "description": "string",
  "facebookLink": "string",
  "id": "string",
  "instagramLink": "string",
  "linkedinLink": "string",
  "profilePicture": "string",
  "ticktockLink": "string",
  "topTraderData": {
    "aumFraction": "number (double)",
    "depositFraction": "number (double)",
    "enabled": "boolean",
    "payoutMethod": "string"
  },
  "userUuid": "string",
  "verified": "boolean"
}
admin-customer-resource

getCustomerSPARData

GET /v2/admin/customers/{userUuid}/spar
userUuid: string
in path

userUuid

200 OK
SPARData

Customer SPAR data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "addressDetails": [
    {
      "address": [
        "string"
      ],
      "addressType": "string",
      "careOf": "string",
      "country": "string",
      "postalAddress": "string",
      "postalNumber": "string",
      "validFrom": "string",
      "validUntil": "string"
    }
  ],
  "lastUpdate": "string",
  "personDetails": [
    {
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "usedName": "integer (int32)",
      "validFrom": "string",
      "validUntil": "string"
    }
  ],
  "raw": "string"
}
admin-customer-resource

updateUser

PATCH /v2/admin/customers/{uuid}
AdminCustomerPatch

patch

uuid: string
in path

uuid

Request Content-Types: application/json
Request Example
{
  "authRoles": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "features": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "premiumContact": {
    "action": "string",
    "value": "string"
  },
  "premiumLevel": {
    "action": "string",
    "value": "string"
  },
  "riskCategory": {
    "action": "string",
    "value": "string"
  }
}
200 OK
UserWithRoles

The updated user data

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "authRoles": [
    "string"
  ],
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "features": [
    "string"
  ],
  "firstName": "string",
  "idProvider": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "userProfileAlias": "string",
  "uuid": "string"
}
admin-customer-resource

getUserNotes

GET /v2/admin/customers/{uuid}/notes
uuid: string
in path

uuid

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationAdminLogEntry

Page of user notes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-customer-resource

createUserNote

POST /v2/admin/customers/{uuid}/notes
UserNoteCreateData

note

uuid: string
in path

uuid

Request Content-Types: application/json
Request Example
{
  "note": "string"
}
200 OK
AdminLogEntry

Log entry representing the created note

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}

admin-trade-report-resource

Admin Trade Report Resource

admin-trade-report-resource

marketOrderReportResponse

POST /v2/admin/trade-orders/market/report-response
file: file
in formData

file

200 OK
MarketTradeOrder

The updated trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trade-report-resource

listOrdersToReport

GET /v2/admin/trade-orders/market/report/open
200 OK

List or orders to report

type
string[]
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  "string"
]
admin-trade-report-resource

getTradeOrderTransactionReport

GET /v2/admin/trade-orders/market/{orderId}/report
type: string REPORT, PREVIEW_REPORT REPORT
in query

type

orderId: string
in path

orderId

200 OK
InputStreamResource

Transaction report for order

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-trade-report-resource

marketOrderReportSent

POST /v2/admin/trade-orders/market/{orderId}/report-sent
orderId: string
in path

orderId

200 OK
MarketTradeOrder

The updated trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}

admin-resource

Admin Resource

admin-resource

getAdmin

GET /v2/admin/admin/@me
200 OK
Admin

The currently logged in admin

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "disabled": "boolean",
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "personalNumber": "string",
  "phone": "string",
  "uuid": "string"
}
admin-resource

logoutAdmin

GET /v2/admin/admin/logout
200 OK
GenericResponse

Log out the current admin

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}

admin-suspicious-transactions-resource

Admin Suspicious Transactions Resource

admin-suspicious-transactions-resource

getSuspiciousTransactionsForUser

GET /v2/admin/customers/{userId}/suspicious-transactions
userId: string
in path

userId

200 OK
SuspiciousTransaction

List of suspicious transactions

type
SuspiciousTransaction
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "created": "string",
    "id": "string",
    "status": "string",
    "type": "string",
    "userId": "string"
  }
]
admin-suspicious-transactions-resource

getSuspiciousTransactions

GET /v2/admin/suspicious-transactions
status: string OPEN, RESOLVED OPEN
in query

status

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationSuspiciousTransaction

Page of suspicious transactions

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "created": "string",
      "id": "string",
      "status": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-suspicious-transactions-resource

updateSuspiciousTransactions

POST /v2/admin/suspicious-transactions
200 OK
SuspiciousTransaction

The generated suspicious transactions

type
SuspiciousTransaction
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "created": "string",
    "id": "string",
    "status": "string",
    "type": "string",
    "userId": "string"
  }
]
admin-suspicious-transactions-resource

updateSuspiciousTransaction

PATCH /v2/admin/suspicious-transactions/{transactionId}
SuspiciousTransactionPatch

patch

transactionId: string
in path

transactionId

Request Content-Types: application/json
Request Example
{
  "status": {
    "action": "string",
    "value": "string"
  }
}
200 OK
SuspiciousTransaction

The updated suspicious transaction

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "id": "string",
  "status": "string",
  "type": "string",
  "userId": "string"
}

admin-log-resource

Admin Log Resource

admin-log-resource

getAdminLog

GET /v2/admin/admins/log
types: string[]
in query

types

Array values passed as multiple parameters: ?types=aaa&types=bbb
adminId: string
in query

adminId

pageToken: string
in query

pageToken

200 OK
InternalPageRepresentationAdminLogEntry

A page of log entries

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

admin-portfolio-resource

Admin Portfolio Resource

admin-portfolio-resource

getPortfolios

GET /v2/admin/portfolios
filter: string
in query

filter

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
in query

clientId

templateId: string
in query

templateId

minValue: number (float)
in query

minValue

maxValue: number (float)
in query

maxValue

minReturn: number (float)
in query

minReturn

maxReturn: number (float)
in query

maxReturn

minReturnYTD: number (float)
in query

minReturnYTD

maxReturnYTD: number (float)
in query

maxReturnYTD

minReturnQ: number (float)
in query

minReturnQ

maxReturnQ: number (float)
in query

maxReturnQ

deleted: boolean
in query

deleted

sortField: string CREATED, UPDATED, VALUE, RETURN, RETURN_CURRENT_YEAR, RETURN_CURRENT_QUARTER
in query

sortField

sortOrder: string DESC, ASC
in query

sortOrder

pageToken: string
in query

pageToken

200 OK
TokenizedPagePortfolioListItem

A page of portfolios

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "accountType": "string",
      "clientId": "string",
      "deleted": "boolean",
      "endDate": "string",
      "investmentStrategyType": "string",
      "lastUpdate": "string",
      "name": "string",
      "owner": {
        "identifier": "integer (int64)",
        "name": "string",
        "ownerType": "string",
        "uuid": "string"
      },
      "portfolioIndex": "integer (int32)",
      "riskLevel": "string",
      "startDate": "string",
      "templatePortfolio": {
        "distribution": [
          {
            "asset": {
              "activeManagement": "boolean",
              "added": "string",
              "assetClass": "string",
              "aum": "number (double)",
              "aumCurrency": "string",
              "aumDate": "string",
              "baseValue": {
                "lastClosing": "number (double)",
                "lastClosingDate": "string"
              },
              "benchmarkName": "string",
              "categorySwe": "string",
              "ceo": "string",
              "commentsSwe": "string",
              "country": "string",
              "currency": "string",
              "currencyAllocation": "object",
              "currencyAllocationDate": "string",
              "currencyExchangeFeeDisabled": "boolean",
              "currencyHedged": "boolean",
              "dataSourceExchangeCode": "string",
              "descriptionSwe": "string",
              "dividendCurrency": "string",
              "dividendFrequency": "string",
              "dividendYield": "number (double)",
              "exchangeCode": "string",
              "geoAllocation": "object",
              "geoAllocationDate": "string",
              "geography": "string",
              "holdingsAllocation": "object",
              "holdingsAllocationDate": "string",
              "id": "string",
              "inceptionDate": "string",
              "index": "integer (int32)",
              "isActiveModel": "boolean",
              "isActivePlatform": "boolean",
              "isCollectingData": "boolean",
              "isTradeStopped": "boolean",
              "isin": "string",
              "issuingCompany": "string",
              "kiidUrl": "string",
              "market": "string",
              "metricBeta": "number (double)",
              "metricPe": "number (double)",
              "metricPs": "number (double)",
              "msciEsgDataDate": "string",
              "msciEsgDataPresent": "boolean",
              "msciEsgQualityScore": "number (double)",
              "msciEsgQualityScorePctlGlobal": "number (double)",
              "msciEsgQualityScorePctlPeer": "number (double)",
              "msciEsgRating": "string",
              "msciSustainableImpactPct": "number (double)",
              "msciWaCO2i": "number (double)",
              "name": "string",
              "notes": "string",
              "numEmployees": "integer (int32)",
              "numberOfHoldings": "integer (int32)",
              "numberOfHoldingsDate": "string",
              "orderRoute": "string",
              "replicationStrategy": "string",
              "riskFactor": "string",
              "riskLevel": "integer (int32)",
              "sectors": [
                "string"
              ],
              "sharesTotal": "integer (int32)",
              "shortName": "string",
              "simpleId": "integer (int64)",
              "sri": "boolean",
              "strategyDescriptionSwe": "string",
              "tags": [
                "string"
              ],
              "ter": "number (double)",
              "ticker": "string",
              "tradeFeeDisabled": "boolean",
              "type": "string",
              "ucits": "boolean",
              "url": "string",
              "value": {
                "buy": "number (double)",
                "currency": "string",
                "currencyExchangeRate": "number (double)",
                "fiveYears": "number (double)",
                "last": "number (double)",
                "lastClosing": "number (double)",
                "lastClosingDate": "string",
                "lastPeriodUpdate": "string",
                "lastValueUpdated": "string",
                "oneMonth": "number (double)",
                "oneYear": "number (double)",
                "sell": "number (double)",
                "sixMonths": "number (double)",
                "thisYear": "number (double)",
                "threeMonths": "number (double)",
                "threeYears": "number (double)"
              }
            },
            "fraction": "number (double)"
          }
        ],
        "estimatedReturn": "number (double)",
        "id": "string",
        "lastDistributionChange": "integer (int64)",
        "lastDistributionRefresh": "integer (int64)",
        "maxDD": "number (double)",
        "name": "string",
        "strategyIndex": "string",
        "targetDistribution": {
          "alternative": "number (double)",
          "bonds": "number (double)",
          "commodities": "number (double)",
          "stocks": "number (double)"
        },
        "targetVar": "number (double)",
        "trackingPortfolio": "string",
        "type": "string",
        "var": "number (double)",
        "volatility": "number (double)"
      },
      "uuid": "string",
      "value": {
        "historicalReturn": "number (double)",
        "returnCurrentQuarter": "number (double)",
        "returnCurrentYear": "number (double)",
        "returnValue": "number (double)",
        "returnValueLatestMonth": "number (double)",
        "returnValueLatestYear": "number (double)",
        "totalEarnings": "number (double)",
        "totalInvested": "number (double)",
        "totalValue": "number (double)",
        "totalWithdrawn": "number (double)",
        "updated": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-portfolio-resource

checkTotalBalance

GET /v2/admin/portfolios/balance/control
200 OK
PortfolioPart

System total balance

type
PortfolioPart
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "assetId": "string"
  }
]
admin-portfolio-resource

getPortfoliosLog

POST /v2/admin/portfolios/log
PortfoliosLogFilter

filter

pageSize: integer (int32)
in query

pageSize

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "clientId": "string",
  "maxTimestamp": "string",
  "minTimestamp": "string",
  "portfolioId": "string",
  "sourceCode": "string",
  "templatePortfolioIds": [
    "string"
  ],
  "types": [
    "string"
  ]
}
200 OK
TokenizedPagePortfolioLogEntry

AFetch portfolio log items matching the given filter criteria

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-portfolio-resource

queueReallocateByTemplateId

POST /v2/admin/portfolios/reallocate/{templateId}
templateId: string
in path

templateId

200 OK
PortfolioBulkActionResponse

The reallocation response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "failureIds": [
    "string"
  ],
  "skippedIds": [
    "string"
  ],
  "successIds": [
    "string"
  ]
}
admin-portfolio-resource

getTradedVolumeForMonth

GET /v2/admin/portfolios/trade-volume
year: integer (int32)
in query

year

month: integer (int32)
in query

month

200 OK
TimeSeriesEntry

Total trade volume for all portfolios during selected period

type
TimeSeriesEntry
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "dateTime": "string",
    "value": "number (double)"
  }
]
admin-portfolio-resource

getPortfolio

GET /v2/admin/portfolios/{portfolioId}
portfolioId: string
in path

portfolioId

200 OK
PortfolioDataWithOwner

A portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "owner": {
    "ownerType": "string",
    "uuid": "string"
  },
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}
admin-portfolio-resource

updatePortfolio

PATCH /v2/admin/portfolios/{portfolioId}
PortfolioDataAdminPatch

patch

portfolioId: string
in path

portfolioId

Request Content-Types: application/json
Request Example
{
  "fee": {
    "action": "string",
    "value": {
      "managementFee": {
        "action": "string",
        "value": "number (double)"
      },
      "safekeepingFee": {
        "action": "string",
        "value": "number (double)"
      }
    }
  }
}
200 OK
InternalPageRepresentationPortfolioLogEntry

The updated portfolio

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-portfolio-resource

getAccountNumber

GET /v2/admin/portfolios/{portfolioId}/account-number
portfolioId: string
in path

portfolioId

200 OK
PortfolioAccountNumber

Account number for portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountNumber": "string"
}
admin-portfolio-resource

checkPortfolioBalance

GET /v2/admin/portfolios/{portfolioId}/balance
portfolioId: string
in path

portfolioId

200 OK
PortfolioPartDiffRepresentation

The portfolio balance diff

type
PortfolioPartDiffRepresentation
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "assetId": "string",
    "expectedAmount": "number (double)",
    "lastSavedAmount": "number (double)"
  }
]
admin-portfolio-resource

addPortfolioDiscount

POST /v2/admin/portfolios/{portfolioId}/discount
FeeDiscountCreateData

data

portfolioId: string
in path

portfolioId

Request Content-Types: application/json
Request Example
{
  "managementFee": "number (double)",
  "periodEnd": "string",
  "periodStart": "string",
  "safekeepingFee": "number (double)"
}
200 OK
FeeDiscount

The added discount

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "canceled": "string",
  "created": "string",
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "id": "string",
  "periodEnd": "string",
  "periodStart": "string"
}
admin-portfolio-resource

cancelPortfolioDiscount

DELETE /v2/admin/portfolios/{portfolioId}/discount/{discountId}
portfolioId: string
in path

portfolioId

discountId: string
in path

discountId

200 OK
FeeDiscount

The canceled discount

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "canceled": "string",
  "created": "string",
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "id": "string",
  "periodEnd": "string",
  "periodStart": "string"
}
admin-portfolio-resource

checkPortfolioDistribution

GET /v2/admin/portfolios/{portfolioId}/distribution
portfolioId: string
in path

portfolioId

200 OK
PortfolioPartDiffRepresentation

The portfolio distribution diff

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "assetId": "string",
  "expectedAmount": "number (double)",
  "lastSavedAmount": "number (double)"
}
admin-portfolio-resource

addError

POST /v2/admin/portfolios/{portfolioId}/errors
portfolioId: string
in path

portfolioId

message: string
in query

message

200 OK
PortfolioDataWithOwner

The updated portfolio (now with error)

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "owner": {
    "ownerType": "string",
    "uuid": "string"
  },
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}
admin-portfolio-resource

clearErrors

POST /v2/admin/portfolios/{portfolioId}/errors/clear
portfolioId: string
in path

portfolioId

200 OK
PortfolioDataWithOwner

The updated portfolio

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "owner": {
    "ownerType": "string",
    "uuid": "string"
  },
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}
admin-portfolio-resource

deductFee

POST /v2/admin/portfolios/{portfolioId}/fee
portfolioId: string
in path

portfolioId

200 OK
PortfolioDataWithOwner

The updated portfolio

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "owner": {
    "ownerType": "string",
    "uuid": "string"
  },
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}
admin-portfolio-resource

getAccruedFee

GET /v2/admin/portfolios/{portfolioId}/fee/accrued
portfolioId: string
in path

portfolioId

200 OK
AccruedFee

Accrued fee for portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adjustedFee": "number (double)",
  "endDate": "string",
  "fee": "number (double)",
  "startDate": "string",
  "transferredFee": "number (double)"
}
admin-portfolio-resource

addFeeAdjustment

POST /v2/admin/portfolios/{portfolioId}/fee/adjustment
FeeAdjustment

feeAdjustment

portfolioId: string
in path

portfolioId

Request Content-Types: application/json
Request Example
{
  "amount": "number (double)"
}
200 OK
AccruedFee

Accrued fee for portfolio (after adjustment)

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adjustedFee": "number (double)",
  "endDate": "string",
  "fee": "number (double)",
  "startDate": "string",
  "transferredFee": "number (double)"
}
admin-portfolio-resource

getPortfolioMarketReturnHistory

GET /v2/admin/portfolios/{portfolioId}/history/market-return
portfolioId: string
in path

portfolioId

200 OK
TimeSeriesEntry

Historical portfolio return (TWR)

type
TimeSeriesEntry
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "dateTime": "string",
    "value": "number (double)"
  }
]
admin-portfolio-resource

getPortfolioReturnHistory

GET /v2/admin/portfolios/{portfolioId}/history/return
portfolioId: string
in path

portfolioId

200 OK
TimeSeriesEntry

Historical portfolio return

type
TimeSeriesEntry
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "dateTime": "string",
    "value": "number (double)"
  }
]
admin-portfolio-resource

getPortfolioValueHistory

GET /v2/admin/portfolios/{portfolioId}/history/value
portfolioId: string
in path

portfolioId

200 OK
TimeSeriesEntry

Historical portfolio values

type
TimeSeriesEntry
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "dateTime": "string",
    "value": "number (double)"
  }
]
admin-portfolio-resource

getPortfolioLog

GET /v2/admin/portfolios/{portfolioId}/log
portfolioId: string
in path

portfolioId

types: string[] PORTFOLIO_CREATED, PORTFOLIO_DEPOSIT, PORTFOLIO_INTERNAL_TRANSFER, PORTFOLIO_DEPOSIT_MONOPOLY, PORTFOLIO_EXTERNAL_TRANSFER, PORTFOLIO_DIVIDEND_TRANSFER, PORTFOLIO_INIT_WITHDRAWAL, PORTFOLIO_INIT_TRANSACTION, PORTFOLIO_CASH_TRANSACTION, PORTFOLIO_QUEUE_REALLOC, PORTFOLIO_TRADE_ESTIMATE, PORTFOLIO_TRADE_COMPLETED, PORTFOLIO_TRADE_SETTLED, PORTFOLIO_TRADE_CANCELLATION, PORTFOLIO_CASH_RESERVATION, PORTFOLIO_TEMPLATE_ASSIGNMENT, PORTFOLIO_UPDATE, PORTFOLIO_ADMIN_UPDATE, PORTFOLIO_STRATEGY_UPDATE, PORTFOLIO_SET_ERROR, PORTFOLIO_TRADE_ORDER_CANCELLED, PORTFOLIO_TRADE_ORDER_RECURRING_UP, PORTFOLIO_FEE_DEDUCTED, PORTFOLIO_FEE_TRANSFERRED, PORTFOLIO_FEE_ADJUSTED, PORTFOLIO_ISK_REPORT, PORTFOLIO_ISK_REPORT_2022, PORTFOLIO_ISK_REPORT_2023, PORTFOLIO_DISCOUNT_ADDED, PORTFOLIO_DISCOUNT_CANCELED, PORTFOLIO_DELETED, ASSET_UPDATE, ASSET_DIVIDEND, PORTFOLIO_REFERRAL_PAYOUT, USER_MIGRATION
in query

types

Array values passed as multiple parameters: ?types=aaa&types=bbb
page: integer (int32) 0
in query

page

sort: string
in query

sort

200 OK
InternalPageRepresentationPortfolioLogEntry

A page of portfolio log items

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-portfolio-resource

getPortfolioTradeOrders

POST /v2/admin/portfolios/{portfolioId}/portfolio-trade-orders
PortfolioTradeOrderFilter

filter

portfolioId: string
in path

portfolioId

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "assetId": "string",
  "maxDate": "string",
  "minDate": "string",
  "orderState": [
    "string"
  ],
  "orderType": "string",
  "portfolioType": "string",
  "recurring": "string",
  "source": "string",
  "sourceType": "string",
  "target": "string",
  "targetType": "string"
}
200 OK
TokenizedPagePortfolioTradeOrder

Portfolio trade orders for portfolio

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "amount": "number (double)",
      "assets": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "tradeUnit": "string",
          "value": "number (double)"
        }
      ],
      "created": "string",
      "currency": "string",
      "id": "string",
      "marketOrderId": "string",
      "orderEstimates": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currencyExchangeFee": "number (double)",
          "currencyExchangeRate": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "price": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "tradeFee": "number (double)",
          "type": "string",
          "value": "number (double)"
        }
      ],
      "orderState": "string",
      "ownerId": "string",
      "portfolioId": "string",
      "recurringSource": "string",
      "simpleId": "integer (int32)",
      "sourceId": "string",
      "sourceType": "string",
      "targetId": "string",
      "targetType": "string",
      "tradeGroupId": "string",
      "tradeId": "string",
      "transactionDay": "integer (int32)",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-portfolio-resource

queueReallocation

POST /v2/admin/portfolios/{portfolioId}/reallocate
portfolioId: string
in path

portfolioId

200 OK
PortfolioDataWithOwner

The updated portfolio

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "owner": {
    "ownerType": "string",
    "uuid": "string"
  },
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}
admin-portfolio-resource

getTemplatePortfolio

GET /v2/admin/portfolios/{portfolioId}/template
portfolioId: string
in path

portfolioId

200 OK
TemplatePortfolio

The template portfolio used by the given portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "id": "string",
  "lastDistributionChange": "integer (int64)",
  "lastDistributionRefresh": "integer (int64)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "trackingPortfolio": "string",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}
admin-portfolio-resource

distributeOrder

POST /v2/admin/portfolios/{portfolioId}/trade-orders/market/distribute
portfolioId: string
in path

portfolioId

suppress: boolean false
in query

suppress

200 OK
InternalTradeOrderRepresentation

Trade order with distribution result

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "errors": [
    {
      "errorMessage": "string",
      "portfolioId": "string"
    }
  ],
  "marketOrderId": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "currencyFee": "number (double)",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "savedCurrencyFee": "number (double)",
      "savedTradeFee": "number (double)",
      "settlementTimestamp": "integer (int64)",
      "tradeFee": "number (double)",
      "tradeFeeType": "string",
      "tradeMethod": "string",
      "tradeOrderId": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "portfolios": [
    {
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "currencyFee": "number (double)",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "savedCurrencyFee": "number (double)",
          "savedTradeFee": "number (double)",
          "settlementTimestamp": "integer (int64)",
          "tradeFee": "number (double)",
          "tradeFeeType": "string",
          "tradeMethod": "string",
          "tradeOrderId": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "portfolioId": "string"
    }
  ],
  "status": "string",
  "tradeOrderId": "string"
}
admin-portfolio-resource

getTradeEstimate

GET /v2/admin/portfolios/{portfolioId}/trade-orders/market/estimate
portfolioId: string
in path

portfolioId

orderType: string
in query

orderType

200 OK
TradeOrderEstimate

Trade estimate for portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "errors": "object",
  "estimates": [
    {
      "assetId": "string",
      "calculatedValue": {
        "buy": "number (double)",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "last": "number (double)",
        "lastValueUpdated": "string",
        "sell": "number (double)"
      },
      "estimate": "number (double)",
      "estimateAbsAmount": "number (double)",
      "estimateTradeAmount": "number (double)",
      "estimationUnit": "string",
      "inStore": "number (double)",
      "tradeMethod": "string",
      "type": "string"
    }
  ],
  "includedPortfolioTradeOrders": [
    {
      "portfolioId": "string",
      "portfolioTradeOrderId": "string"
    }
  ]
}
admin-portfolio-resource

getPortfolioValue

GET /v2/admin/portfolios/{portfolioId}/value
portfolioId: string
in path

portfolioId

200 OK
PortfolioValueWithReservations

Value of portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "historicalReturn": "number (double)",
  "reservations": {
    "feeAmount": "number (double)",
    "settlementAmount": "number (double)",
    "totalAmount": "number (double)",
    "withdrawalAmount": "number (double)"
  },
  "reservedAmount": "number (double)",
  "returnCurrentQuarter": "number (double)",
  "returnCurrentYear": "number (double)",
  "returnValue": "number (double)",
  "returnValueLatestMonth": "number (double)",
  "returnValueLatestYear": "number (double)",
  "totalEarnings": "number (double)",
  "totalInvested": "number (double)",
  "totalValue": "number (double)",
  "totalWithdrawn": "number (double)",
  "updated": "string"
}

log-resource

Log Resource

log-resource

getAutoBalanceCheck

GET /v2/admin/log/balance/auto-check
pageToken: string
in query

pageToken

200 OK
AssetStorageCheckResultItem

Log entry for auto balance check

type
AssetStorageCheckResultItem
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "fileId": "string",
    "logItemId": "string",
    "result": {
      "date": "string",
      "fileType": "string",
      "result": [
        {
          "assetId": "string",
          "bankAmount": "number (double)",
          "isin": "string",
          "successful": "boolean",
          "systemAmount": "number (double)"
        }
      ],
      "successful": "boolean"
    },
    "resultType": "string"
  }
]
log-resource

getLastAutoBalanceCheck

GET /v2/admin/log/balance/auto-check/last
resultType: string HOLDINGS_CHECK, CASH_BALANCE_CHECK
in query

resultType

200 OK
AssetStorageCheckResultItem

Last auto check result of given type

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "fileId": "string",
  "logItemId": "string",
  "result": {
    "date": "string",
    "fileType": "string",
    "result": [
      {
        "assetId": "string",
        "bankAmount": "number (double)",
        "isin": "string",
        "successful": "boolean",
        "systemAmount": "number (double)"
      }
    ],
    "successful": "boolean"
  },
  "resultType": "string"
}
log-resource

registerBalanceCheckCompleted

POST /v2/admin/log/balance/manual-check/checked
checkType: string MANUAL, SEMI_AUTOMATED MANUAL
in query

checkType

200 OK
AdminLogEntry

Log entry for completed balance check

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}
log-resource

getLastBalanceCheck

GET /v2/admin/log/balance/manual-check/last
200 OK
AdminLogEntry

Log entry for last balance check

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}
log-resource

getTotalBalanceForDate

GET /v2/admin/log/balance/total
200 OK
TotalBalanceItem

Total asset balance balance of specified date

type
TotalBalanceItem
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "assetId": "string",
    "invested": "number (double)",
    "isin": "string",
    "price": "number (double)",
    "storage": "number (double)",
    "type": "string"
  }
]

admin-template-portfolio-resource

Admin Template Portfolio Resource

admin-template-portfolio-resource

getTemplates

GET /v2/admin/template-portfolios
200 OK
TemplatePortfolio

All template portfolios

type
TemplatePortfolio
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  }
]
admin-template-portfolio-resource

createTemplate

POST /v2/admin/template-portfolios
TemplatePortfolioCreateData

body

Request Content-Types: application/json
Request Example
{
  "distribution": [
    {
      "assetId": "string",
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}
200 OK
TemplatePortfolio

A template portfolio

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "id": "string",
  "lastDistributionChange": "integer (int64)",
  "lastDistributionRefresh": "integer (int64)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "trackingPortfolio": "string",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}
admin-template-portfolio-resource

listCustomTemplatePortfolios

POST /v2/admin/template-portfolios/custom
CustomTemplatePortfolioFilter

filter

pageSize: integer (int32)
in query

pageSize

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "accessibility": [
    "string"
  ],
  "category": [
    "string"
  ],
  "invertOrder": "boolean",
  "order": "string",
  "ownerId": "string",
  "searchQuery": "string",
  "templateIds": [
    "string"
  ]
}
200 OK
TokenizedPageSharedCustomTemplate

A page of shared template portfolios

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "accessibility": "string",
      "created": "string",
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "id": "string",
      "meta": {
        "assetTypes": [
          "string"
        ],
        "categories": [
          "string"
        ],
        "description": "string",
        "grade": "integer (int32)",
        "name": "string",
        "rank": "integer (int32)",
        "sri": "boolean",
        "status": {
          "level": "string",
          "trigger": "string"
        }
      },
      "ownerId": "string",
      "published": "string",
      "sharerProfile": {
        "alias": "string",
        "description": "string",
        "facebookLink": "string",
        "id": "string",
        "instagramLink": "string",
        "linkedinLink": "string",
        "profilePicture": "string",
        "ticktockLink": "string",
        "topTraderData": {
          "aumFraction": "number (double)",
          "depositFraction": "number (double)",
          "enabled": "boolean",
          "payoutMethod": "string"
        },
        "userUuid": "string",
        "verified": "boolean"
      },
      "ter": "number (double)",
      "trackingPortfolioId": "string",
      "value": {
        "aum": "number (double)",
        "distribution": {
          "alternatives": "integer (int32)",
          "commodities": "integer (int32)",
          "equity": "integer (int32)",
          "fixedIncome": "integer (int32)"
        },
        "fiveYears": "number (double)",
        "followers": "integer (int32)",
        "lastPeriodUpdate": "string",
        "oneMonth": "number (double)",
        "oneYear": "number (double)",
        "sixMonths": "number (double)",
        "thisYear": "number (double)",
        "threeMonths": "number (double)",
        "threeYears": "number (double)"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-template-portfolio-resource

updateCustomTemplateTerValue

POST /v2/admin/template-portfolios/custom/ter
200 OK
CompletableFuture«GenericResponse»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-template-portfolio-resource

getCustomTemplate

GET /v2/admin/template-portfolios/custom/{templateId}
templateId: string
in path

templateId

200 OK
SharedCustomTemplate

A custom template portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accessibility": "string",
  "created": "string",
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "id": "string",
  "meta": {
    "assetTypes": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "description": "string",
    "grade": "integer (int32)",
    "name": "string",
    "rank": "integer (int32)",
    "sri": "boolean",
    "status": {
      "level": "string",
      "trigger": "string"
    }
  },
  "ownerId": "string",
  "published": "string",
  "sharerProfile": {
    "alias": "string",
    "description": "string",
    "facebookLink": "string",
    "id": "string",
    "instagramLink": "string",
    "linkedinLink": "string",
    "profilePicture": "string",
    "ticktockLink": "string",
    "topTraderData": {
      "aumFraction": "number (double)",
      "depositFraction": "number (double)",
      "enabled": "boolean",
      "payoutMethod": "string"
    },
    "userUuid": "string",
    "verified": "boolean"
  },
  "ter": "number (double)",
  "trackingPortfolioId": "string",
  "value": {
    "aum": "number (double)",
    "distribution": {
      "alternatives": "integer (int32)",
      "commodities": "integer (int32)",
      "equity": "integer (int32)",
      "fixedIncome": "integer (int32)"
    },
    "fiveYears": "number (double)",
    "followers": "integer (int32)",
    "lastPeriodUpdate": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-template-portfolio-resource

getCustomTemplatePortfolioHistory

GET /v2/admin/template-portfolios/custom/{templateId}/history
templateId: string
in path

templateId

200 OK
TimeSeriesEntry

The requested custom template portfolio return history

type
TimeSeriesEntry
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "dateTime": "string",
    "value": "number (double)"
  }
]
admin-template-portfolio-resource

getCustomTemplatePortfolioLog

POST /v2/admin/template-portfolios/custom/{templateId}/log
CustomTemplateLogFilter

filter

templateId: string
in path

templateId

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "minTimestamp": "string",
  "types": [
    "string"
  ]
}
200 OK
TokenizedPageCustomTemplateLog

A page of shared template portfolios

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "logEntryType": "string",
      "ownerId": "string",
      "payload": "object",
      "templateId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-template-portfolio-resource

getCustomTemplatePortfolioHistoryMetrics

GET /v2/admin/template-portfolios/custom/{templateId}/metrics
templateId: string
in path

templateId

200 OK
CustomTemplateMetric

Historical metric data for shared portfolio

type
CustomTemplateMetric
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "aum": "number (double)",
    "dateTime": "string",
    "distribution": {
      "alternatives": "integer (int32)",
      "commodities": "integer (int32)",
      "equity": "integer (int32)",
      "fixedIncome": "integer (int32)"
    },
    "followers": "integer (int32)"
  }
]
admin-template-portfolio-resource

updateCustomTemplateTerValue

POST /v2/admin/template-portfolios/custom/{templateId}/ter
templateId: string
in query

templateId

200 OK
CompletableFuture«GenericResponse»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-template-portfolio-resource

exportTemplates

GET /v2/admin/template-portfolios/distribution
200 OK
InputStreamResource

CSV data with all template portfolio distributions

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-template-portfolio-resource

updateTemplates

PATCH /v2/admin/template-portfolios/distribution
CSVDataContainer

body

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
TemplatePortfolio

The updated template portfolios

type
TemplatePortfolio
204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  }
]
admin-template-portfolio-resource

getTemplateDiff

POST /v2/admin/template-portfolios/distribution/diff
CSVDataContainer

body

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
TemplatePortfolioDistributionUpdate

The diff between the current templates and the uploaded data

type
TemplatePortfolioDistributionUpdate
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "distribution": [
      {
        "assetId": "string",
        "currentFraction": "number (double)",
        "updatedFraction": "number (double)"
      }
    ],
    "id": "string",
    "name": "string"
  }
]
admin-template-portfolio-resource

replaceAssetInTemplatePortfolios

PATCH /v2/admin/template-portfolios/distribution/replace
selectionString: string all
in query

selectionString

200 OK
TemplatePortfolio

The updated template portfolios

type
TemplatePortfolio
204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  }
]
admin-template-portfolio-resource

exportTemplateMeta

GET /v2/admin/template-portfolios/meta
200 OK
InputStreamResource

CSV representation of all template portfolio meta

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-template-portfolio-resource

updateTemplateMeta

PATCH /v2/admin/template-portfolios/meta
CSVDataContainer

body

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
TemplatePortfolio

The updated template portfolios

type
TemplatePortfolio
204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  }
]
admin-template-portfolio-resource

refreshTemplateDistributions

POST /v2/admin/template-portfolios/refresh
200 OK
GenericResponse

A response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-template-portfolio-resource

getTemplate

GET /v2/admin/template-portfolios/{templateId}
templateId: string
in path

templateId

200 OK
TemplatePortfolio

A template portfolio

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "id": "string",
  "lastDistributionChange": "integer (int64)",
  "lastDistributionRefresh": "integer (int64)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "trackingPortfolio": "string",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}
admin-template-portfolio-resource

updateTemplate

PATCH /v2/admin/template-portfolios/{templateId}
TemplatePortfolioPatch

patch

templateId: string
in path

templateId

Request Content-Types: application/json
Request Example
{
  "distribution": {
    "action": "string",
    "value": [
      {
        "assetId": "string",
        "fraction": "number (double)"
      }
    ]
  },
  "estimatedReturn": {
    "action": "string",
    "value": "number (double)"
  },
  "maxDD": {
    "action": "string",
    "value": "number (double)"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "targetDistribution": {
    "action": "string",
    "value": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    }
  },
  "targetVar": {
    "action": "string",
    "value": "number (double)"
  },
  "trackingPortfolio": {
    "action": "string",
    "value": "string"
  },
  "var": {
    "action": "string",
    "value": "number (double)"
  },
  "volatility": {
    "action": "string",
    "value": "number (double)"
  }
}
200 OK
TemplatePortfolio

The updated template portfolio

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "id": "string",
  "lastDistributionChange": "integer (int64)",
  "lastDistributionRefresh": "integer (int64)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "trackingPortfolio": "string",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}
admin-template-portfolio-resource

getTemplateDistribution

GET /v2/admin/template-portfolios/{templateId}/distribution
templateId: string
in path

templateId

200 OK
TemplatePortfolioDistributionPart

Distribution for the template portfolio

type
TemplatePortfolioDistributionPart
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "asset": {
      "activeManagement": "boolean",
      "added": "string",
      "assetClass": "string",
      "aum": "number (double)",
      "aumCurrency": "string",
      "aumDate": "string",
      "baseValue": {
        "lastClosing": "number (double)",
        "lastClosingDate": "string"
      },
      "benchmarkName": "string",
      "categorySwe": "string",
      "ceo": "string",
      "commentsSwe": "string",
      "country": "string",
      "currency": "string",
      "currencyAllocation": "object",
      "currencyAllocationDate": "string",
      "currencyExchangeFeeDisabled": "boolean",
      "currencyHedged": "boolean",
      "dataSourceExchangeCode": "string",
      "descriptionSwe": "string",
      "dividendCurrency": "string",
      "dividendFrequency": "string",
      "dividendYield": "number (double)",
      "exchangeCode": "string",
      "geoAllocation": "object",
      "geoAllocationDate": "string",
      "geography": "string",
      "holdingsAllocation": "object",
      "holdingsAllocationDate": "string",
      "id": "string",
      "inceptionDate": "string",
      "index": "integer (int32)",
      "isActiveModel": "boolean",
      "isActivePlatform": "boolean",
      "isCollectingData": "boolean",
      "isTradeStopped": "boolean",
      "isin": "string",
      "issuingCompany": "string",
      "kiidUrl": "string",
      "market": "string",
      "metricBeta": "number (double)",
      "metricPe": "number (double)",
      "metricPs": "number (double)",
      "msciEsgDataDate": "string",
      "msciEsgDataPresent": "boolean",
      "msciEsgQualityScore": "number (double)",
      "msciEsgQualityScorePctlGlobal": "number (double)",
      "msciEsgQualityScorePctlPeer": "number (double)",
      "msciEsgRating": "string",
      "msciSustainableImpactPct": "number (double)",
      "msciWaCO2i": "number (double)",
      "name": "string",
      "notes": "string",
      "numEmployees": "integer (int32)",
      "numberOfHoldings": "integer (int32)",
      "numberOfHoldingsDate": "string",
      "orderRoute": "string",
      "replicationStrategy": "string",
      "riskFactor": "string",
      "riskLevel": "integer (int32)",
      "sectors": [
        "string"
      ],
      "sharesTotal": "integer (int32)",
      "shortName": "string",
      "simpleId": "integer (int64)",
      "sri": "boolean",
      "strategyDescriptionSwe": "string",
      "tags": [
        "string"
      ],
      "ter": "number (double)",
      "ticker": "string",
      "tradeFeeDisabled": "boolean",
      "type": "string",
      "ucits": "boolean",
      "url": "string",
      "value": {
        "buy": "number (double)",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "fiveYears": "number (double)",
        "last": "number (double)",
        "lastClosing": "number (double)",
        "lastClosingDate": "string",
        "lastPeriodUpdate": "string",
        "lastValueUpdated": "string",
        "oneMonth": "number (double)",
        "oneYear": "number (double)",
        "sell": "number (double)",
        "sixMonths": "number (double)",
        "thisYear": "number (double)",
        "threeMonths": "number (double)",
        "threeYears": "number (double)"
      }
    },
    "fraction": "number (double)"
  }
]
admin-template-portfolio-resource

getTemplatePortfolioLog

GET /v2/admin/template-portfolios/{templateId}/log
templateId: string
in path

templateId

logType: string ADMIN_LOGIN, ADMIN_VERIFY_USER, ADMIN_CREATED, ADMIN_UPDATED, TRANSACTIONS_EXPORTED, TRANSACTION_EXPORTED, TRANSACTION_COMPLETED, TRADE_GENERATED, TRADE_COMPLETED, TRADE_CANCELED, TEMPLATE_PORTFOLIO_CREATE, TEMPLATE_PORTFOLIO_UPDATE, TEMPLATE_PORTFOLIO_DIST_REFRESH, PORTFOLIO_ERROR_CLEARED, PORTFOLIO_FEE_ADJUSTMENT_ADDED, ASSET_STORAGE_DEPOSIT, ASSET_STORAGE_DIFF_CHECKPOINT, BALANCE_CHECKPOINT, MARKET_TRADE_ORDER_UPDATED, MARKET_TRADE_ORDER_COMPLETED, MARKET_TRADE_ORDER_SEMICOMPLETED, MARKET_TRADE_ORDER_CANCELED, MARKET_TRADE_ORDER_VOVERRIDE, USER_KNOWLEDGE_UPDATED, USER_NOTE, MANUAL_BALANCE_CHECK, CASH_BALANCE_CHECK, HOLDINGS_CHECK, TOTAL_BALANCE, SUSPICIOUS_TRANSACTION_UPDATED, ASSET_UPDATE, ASSET_TRANSACTION, NOTIFICATION_CREATED, NOTIFICATION_UPDATED, USER_MIGRATED
in query

logType

200 OK
InternalPageRepresentationAdminLogEntry

A page of the template portfolio log

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

admin-trading-forced-resource

Admin Trading Forced Resource

admin-trading-forced-resource

queueForceSell

POST /v2/admin/forced-trade/sell/{assetId}
assetId: string
in path

assetId

200 OK
GenericResponse

Result

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-trading-forced-resource

queueForceSell

POST /v2/admin/forced-trade/sell/{assetId}/{portfolioId}
assetId: string
in path

assetId

portfolioId: string
in path

portfolioId

200 OK
GenericResponse

Result

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-trading-forced-resource

queueForceUnregister

POST /v2/admin/forced-trade/unregister/{assetId}
assetId: string
in path

assetId

200 OK
GenericResponse

Result

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-trading-forced-resource

queueForceUnregister

POST /v2/admin/forced-trade/unregister/{assetId}/{portfolioId}
assetId: string
in path

assetId

portfolioId: string
in path

portfolioId

200 OK
GenericResponse

Result

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}

admin-trading-resource

Admin Trading Resource

admin-trading-resource

getOrders

GET /v2/admin/trade-orders
page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationInternalTradeOrderListItemRepresentation

Page of trade orders

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "created": "string",
      "hasError": "boolean",
      "parentOrderId": "string",
      "status": "string",
      "tradeOrderId": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-trading-resource

getMarketTradeOrders

GET /v2/admin/trade-orders/market
page: integer (int32) 0
in query

page

sortOrder: string DESC, ASC
in query

sortOrder

minDate: string
in query

minDate

maxDate: string
in query

maxDate

200 OK
InternalPageRepresentationMarketTradeOrder

A page of market trade orders

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "children": [
        "#/definitions/MarketTradeOrder"
      ],
      "completedOrders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "baseTradeFee": "number (double)",
          "currency": "string",
          "currencyConversionFee": "number (double)",
          "currencyConversionRatio": "number (double)",
          "itemId": "string",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "settlementTimestamp": "integer (int64)",
          "state": "string",
          "tradeFee": "number (double)",
          "tradeMethod": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "created": "string",
      "orderType": "string",
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "estimateAbsAmount": "number (double)",
          "estimatedPrice": "number (double)",
          "tradeMethod": "string",
          "type": "string",
          "unit": "string"
        }
      ],
      "parentOrderId": "string",
      "status": "string",
      "uuid": "string",
      "version": "integer (int32)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-trading-resource

createMarketTradeOrder

POST /v2/admin/trade-orders/market
TradeOrderCreatePayload

orderEstimate

parentOrderId: string
in query

parentOrderId

orderType: string
in query

orderType

Request Content-Types: application/json
Request Example
{
  "includedPortfolioTradeOrders": [
    {
      "portfolioId": "string",
      "portfolioTradeOrderId": "string"
    }
  ],
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ]
}
200 OK
MarketTradeOrder

The created market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

getTradeEstimate

GET /v2/admin/trade-orders/market/estimate
orderType: string
in query

orderType

200 OK
TradeOrderEstimate

A trade order estimate

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "errors": "object",
  "estimates": [
    {
      "assetId": "string",
      "calculatedValue": {
        "buy": "number (double)",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "last": "number (double)",
        "lastValueUpdated": "string",
        "sell": "number (double)"
      },
      "estimate": "number (double)",
      "estimateAbsAmount": "number (double)",
      "estimateTradeAmount": "number (double)",
      "estimationUnit": "string",
      "inStore": "number (double)",
      "tradeMethod": "string",
      "type": "string"
    }
  ],
  "includedPortfolioTradeOrders": [
    {
      "portfolioId": "string",
      "portfolioTradeOrderId": "string"
    }
  ]
}
admin-trading-resource

listMarketTradeOrders

GET /v2/admin/trade-orders/market/list
page: integer (int32) 0
in query

page

minDate: string
in query

minDate

maxDate: string
in query

maxDate

200 OK
InternalPageRepresentationInternalTradeOrderListItemRepresentation

A page of market trade list items

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "created": "string",
      "hasError": "boolean",
      "parentOrderId": "string",
      "status": "string",
      "tradeOrderId": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-trading-resource

getOpenMarketTradeOrders

GET /v2/admin/trade-orders/market/open
200 OK
InternalTradeOrderListItemRepresentation

List of open market trade orders

type
InternalTradeOrderListItemRepresentation
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "created": "string",
    "hasError": "boolean",
    "parentOrderId": "string",
    "status": "string",
    "tradeOrderId": "string",
    "type": "string"
  }
]
admin-trading-resource

getMarketTradeOrder

GET /v2/admin/trade-orders/market/{orderId}
orderId: string
in path

orderId

200 OK
MarketTradeOrder

Market trade order

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

updateMarketTradeOrder

PATCH /v2/admin/trade-orders/market/{orderId}
MarketTradeOrderUpdate

update

orderId: string
in path

orderId

clientVersion: integer (int32)
in query

clientVersion

Request Content-Types: application/json
Request Example
{
  "cancelledAffairs": [
    "string"
  ],
  "completedAffairs": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ]
}
200 OK
MarketTradeOrder

The updated market trade order

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

cancelMarketTradeOrder

POST /v2/admin/trade-orders/market/{orderId}/cancel
orderId: string
in path

orderId

clientVersion: integer (int32)
in query

clientVersion

200 OK
MarketTradeOrder

The cancelled market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

completeMarketTradeOrder

POST /v2/admin/trade-orders/market/{orderId}/complete
orderId: string
in path

orderId

clientVersion: integer (int32)
in query

clientVersion

200 OK
MarketTradeOrder

The completed market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

completeMarketTradeOrder

POST /v2/admin/trade-orders/market/{orderId}/complete/{assetId}
orderId: string
in path

orderId

assetId: string
in path

assetId

clientVersion: integer (int32)
in query

clientVersion

200 OK
MarketTradeOrder

The completed market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

getDistributionsForMarketOrder

GET /v2/admin/trade-orders/market/{orderId}/distribute
orderId: string
in path

orderId

200 OK
InternalTradeOrderRepresentation

Distributions for market trade order

type
InternalTradeOrderRepresentation
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "created": "string",
    "errors": [
      {
        "errorMessage": "string",
        "portfolioId": "string"
      }
    ],
    "marketOrderId": "string",
    "orders": [
      {
        "amount": "number (double)",
        "assetId": "string",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "currencyFee": "number (double)",
        "marketplace": [
          "string"
        ],
        "price": "number (double)",
        "priceSource": "string",
        "savedCurrencyFee": "number (double)",
        "savedTradeFee": "number (double)",
        "settlementTimestamp": "integer (int64)",
        "tradeFee": "number (double)",
        "tradeFeeType": "string",
        "tradeMethod": "string",
        "tradeOrderId": "string",
        "tradedTimestamp": "integer (int64)",
        "type": "string"
      }
    ],
    "portfolios": [
      {
        "orders": [
          {
            "amount": "number (double)",
            "assetId": "string",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "currencyFee": "number (double)",
            "marketplace": [
              "string"
            ],
            "price": "number (double)",
            "priceSource": "string",
            "savedCurrencyFee": "number (double)",
            "savedTradeFee": "number (double)",
            "settlementTimestamp": "integer (int64)",
            "tradeFee": "number (double)",
            "tradeFeeType": "string",
            "tradeMethod": "string",
            "tradeOrderId": "string",
            "tradedTimestamp": "integer (int64)",
            "type": "string"
          }
        ],
        "portfolioId": "string"
      }
    ],
    "status": "string",
    "tradeOrderId": "string"
  }
]
admin-trading-resource

distributeOrder

POST /v2/admin/trade-orders/market/{orderId}/distribute
orderId: string
in path

orderId

clientVersion: integer (int32)
in query

clientVersion

suppress: boolean false
in query

suppress

200 OK
InternalTradeOrderRepresentation

The distributed market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "errors": [
    {
      "errorMessage": "string",
      "portfolioId": "string"
    }
  ],
  "marketOrderId": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "currencyFee": "number (double)",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "savedCurrencyFee": "number (double)",
      "savedTradeFee": "number (double)",
      "settlementTimestamp": "integer (int64)",
      "tradeFee": "number (double)",
      "tradeFeeType": "string",
      "tradeMethod": "string",
      "tradeOrderId": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "portfolios": [
    {
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "currencyFee": "number (double)",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "savedCurrencyFee": "number (double)",
          "savedTradeFee": "number (double)",
          "settlementTimestamp": "integer (int64)",
          "tradeFee": "number (double)",
          "tradeFeeType": "string",
          "tradeMethod": "string",
          "tradeOrderId": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "portfolioId": "string"
    }
  ],
  "status": "string",
  "tradeOrderId": "string"
}
admin-trading-resource

marketOrderDistributed

POST /v2/admin/trade-orders/market/{orderId}/distributed
orderId: string
in path

orderId

clientVersion: integer (int32)
in query

clientVersion

200 OK
MarketTradeOrder

The updated market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

getMarketTradeOrderItems

GET /v2/admin/trade-orders/market/{orderId}/items
orderId: string
in path

orderId

format: string DEFAULT, INFRONT
in query

format

200 OK
TradeOrderItem

List of market trade items

type
TradeOrderItem
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "assetId": "string",
    "estimateAbsAmount": "number (double)",
    "estimatedPrice": "number (double)",
    "tradeMethod": "string",
    "type": "string",
    "unit": "string"
  }
]
admin-trading-resource

getMarketTradeOrderItemsFile

GET /v2/admin/trade-orders/market/{orderId}/items/plain
orderId: string
in path

orderId

format: string DEFAULT, INFRONT
in query

format

200 OK
InputStreamResource

File with trade order information, csv file formatted by the provided format parameter

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-trading-resource

getMarketOrderLog

GET /v2/admin/trade-orders/market/{orderId}/log
orderId: string
in path

orderId

size: integer (int32) 0
in query

size

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationAdminLogEntry

The market trade order log

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK) 
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-trading-resource

getTradeOrderTransactionReportMeta

GET /v2/admin/trade-orders/market/{orderId}/report/meta
orderId: string
in path

orderId

200 OK
MarketTradeOrderReportMeta

Market trade order report meta

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "name": "string"
}
admin-trading-resource

marketOrderReported

POST /v2/admin/trade-orders/market/{orderId}/reported
orderId: string
in path

orderId

200 OK
MarketTradeOrder

The reported market trade order

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

updateMarketTradeOrderValidationOverrides

POST /v2/admin/trade-orders/market/{orderId}/validation-override
MarketTradeOrderValidationOverride

override

orderId: string
in path

orderId

Request Content-Types: application/json
Request Example
{
  "assetId": "string",
  "properties": [
    "string"
  ]
}
200 OK
GenericResponse

The override information details

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-trading-resource

updateMarketTradeOrderByConfirmationFile

PATCH /v2/admin/trade-orders/market/{orderId}/{fileId}
orderId: string
in path

orderId

fileId: string
in path

fileId

200 OK
MarketTradeOrder

The updated market trade order

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "children": [
    "#/definitions/MarketTradeOrder"
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}
admin-trading-resource

getTradeOrder

GET /v2/admin/trade-orders/{tradeOrderId}
tradeOrderId: string
in path

tradeOrderId

200 OK
InternalTradeOrderRepresentation

A trade order

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "errors": [
    {
      "errorMessage": "string",
      "portfolioId": "string"
    }
  ],
  "marketOrderId": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "currencyFee": "number (double)",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "savedCurrencyFee": "number (double)",
      "savedTradeFee": "number (double)",
      "settlementTimestamp": "integer (int64)",
      "tradeFee": "number (double)",
      "tradeFeeType": "string",
      "tradeMethod": "string",
      "tradeOrderId": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "portfolios": [
    {
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "currencyFee": "number (double)",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "savedCurrencyFee": "number (double)",
          "savedTradeFee": "number (double)",
          "settlementTimestamp": "integer (int64)",
          "tradeFee": "number (double)",
          "tradeFeeType": "string",
          "tradeMethod": "string",
          "tradeOrderId": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "portfolioId": "string"
    }
  ],
  "status": "string",
  "tradeOrderId": "string"
}
admin-trading-resource

getTradeOrderLog

GET /v2/admin/trade-orders/{tradeOrderId}/log
tradeOrderId: string
in path

tradeOrderId

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationAdminLogEntry

Page of log entries for trade order

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/json
Response Example (200 OK) 
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

admin-organization-resource

Admin Organization Resource

admin-organization-resource

listOrganizations

GET /v2/admin/organizations
status: string
in query

status

pageToken: string
in query

pageToken

200 OK
OrganizationListItem

Page of organizations

type
OrganizationListItem
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "clientId": "string",
    "created": "string",
    "email": "string",
    "lei": "string",
    "name": "string",
    "organizationNumber": {
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string",
      "vatnumber": "string"
    },
    "principal": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    },
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "status": "string",
    "uuid": "string"
  }
]
admin-organization-resource

create

POST /v2/admin/organizations
OrganizationCreateData

createData

Request Content-Types: application/json
Request Example
{
  "knowledge": {
    "cashSources": {
      "action": "string",
      "value": "object"
    },
    "insolvencyProbability": {
      "action": "string",
      "value": "boolean"
    },
    "investmentSize": {
      "action": "string",
      "value": "string"
    },
    "managingCash": {
      "action": "string",
      "value": "boolean"
    }
  },
  "organization": {
    "clientId": "string",
    "confirmEmail": "string",
    "created": "string",
    "email": "string",
    "lei": "string",
    "name": "string",
    "organizationNumber": {
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string",
      "vatnumber": "string"
    },
    "principal": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    },
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "status": "string",
    "uuid": "string"
  }
}
200 OK
OrganizationWithUsers

The created organization

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}
admin-organization-resource

getOrganization

GET /v2/admin/organizations/{orgId}
orgId: string
in path

orgId

200 OK
OrganizationWithUsers

An organizations

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}
admin-organization-resource

deleteOrganization

DELETE /v2/admin/organizations/{orgId}
orgId: string
in path

orgId

200 OK
CustomerDeleteResponse

Delete response

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "customerId": "string",
  "status": "string"
}
admin-organization-resource

updateOrganization

PATCH /v2/admin/organizations/{orgId}
OrganizationAdminPatch

patch

orgId: string
in path

orgId

Request Content-Types: application/json
Request Example
{
  "email": {
    "action": "string",
    "value": "string"
  },
  "lei": {
    "action": "string",
    "value": "string"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "principal": {
    "action": "string",
    "value": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    }
  },
  "riskCategory": {
    "action": "string",
    "value": "string"
  },
  "status": {
    "action": "string",
    "value": "string"
  }
}
200 OK
OrganizationWithUsers

The updated organization

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}
admin-organization-resource

getOrganizationKnowledge

GET /v2/admin/organizations/{orgId}/knowledge
orgId: string
in path

orgId

200 OK
OrganizationKnowledge

The organizations knowledge data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "cashSources": "object",
  "insolvencyProbability": "boolean",
  "investmentSize": "string",
  "lastUpdated": "string",
  "managingCash": "boolean",
  "version": "integer (int32)"
}
admin-organization-resource

updateOrganizationKnowledge

PATCH /v2/admin/organizations/{orgId}/knowledge
OrganizationKnowledgePatch

data

orgId: string
in path

orgId

Request Content-Types: application/json
Request Example
{
  "cashSources": {
    "action": "string",
    "value": "object"
  },
  "insolvencyProbability": {
    "action": "string",
    "value": "boolean"
  },
  "investmentSize": {
    "action": "string",
    "value": "string"
  },
  "managingCash": {
    "action": "string",
    "value": "boolean"
  }
}
200 OK
OrganizationKnowledge

The updated organization knowledge data

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "cashSources": "object",
  "insolvencyProbability": "boolean",
  "investmentSize": "string",
  "lastUpdated": "string",
  "managingCash": "boolean",
  "version": "integer (int32)"
}
admin-organization-resource

getLogByOrgId

GET /v2/admin/organizations/{orgId}/log
orgId: string
in path

orgId

types: string[] USER_CREATE, USER_LOGIN, USER_LOGIN_ORGANIZATION, USER_SIGN, ADMIN_VIEW_USER_LOGIN, ADMIN_VIEW_ORGANIZATION_LOGIN, USER_RECURRING_TRANSACTION_CANCELED, USER_RECURRING_TRANSACTION_ACTIVATED, USER_AUTOGIRO_CANCELED, USER_AUTOGIRO_ACTIVATED, USER_RECURRING_TRANSACTION_CREATED, USER_RECURRING_TRANSACTION_UPDATED, USER_RECURRING_TRANSACTION_DELETED, USER_DELETE, KNOWLEDGE_UPDATED, USER_UPDATED, USER_MIGRATED, ORGANIZATION_DELETE, ORGANIZATION_CREATED, ORGANIZATION_UPDATED, ORGANIZATION_ROLE_UPDATED, ORGANIZATION_KNOWLEDGE_UPDATED, SALES_TAX_REPORT
in query

types

Array values passed as multiple parameters: ?types=aaa&types=bbb
page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationCustomerLogEntry

Page of organization log data

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerLogEntryType": "string",
      "customerUuid": "string",
      "payload": "object",
      "timestamp": "integer (int64)",
      "type": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-organization-resource

getNotes

GET /v2/admin/organizations/{orgId}/notes
orgId: string
in path

orgId

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationCustomerLogEntry

Page of organization notes

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerLogEntryType": "string",
      "customerUuid": "string",
      "payload": "object",
      "timestamp": "integer (int64)",
      "type": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-organization-resource

createNote

POST /v2/admin/organizations/{orgId}/notes
UserNoteCreateData

note

orgId: string
in path

orgId

Request Content-Types: application/json
Request Example
{
  "note": "string"
}
200 OK
AdminLogEntry

The created note

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}
admin-organization-resource

addUser

POST /v2/admin/organizations/{orgId}/roles/{userId}
OrganizationUserData

createData

orgId: string
in path

orgId

userId: string
in path

userId

Request Content-Types: application/json
Request Example
{
  "organizationRole": "string"
}
200 OK
OrganizationWithUsers

The updated organization

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}
admin-organization-resource

updateUser

PATCH /v2/admin/organizations/{orgId}/roles/{userId}
OrganizationUserData

createData

orgId: string
in path

orgId

userId: string
in path

userId

Request Content-Types: application/json
Request Example
{
  "organizationRole": "string"
}
200 OK
OrganizationWithUsers

The updated organization

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}

admin-notification-resource

Admin Notification Resource

admin-notification-resource

getNotificationsForCustomer

GET /v2/admin/notification/customer/{id}
id: string
in path

id

medium: string EMAIL, IN_APP
in query

medium

pageToken: string
in query

pageToken

200 OK
TokenizedPageWithNotifications

A page of notifications

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "generator": {
        "created": "string",
        "enabled": "boolean",
        "filter": {
          "filter": "object"
        },
        "id": "string",
        "medium": "string",
        "name": "string",
        "period": "string",
        "template": {
          "content": "object",
          "contentType": "string",
          "expiration": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        }
      },
      "generatorId": "string",
      "id": "string",
      "ownerId": "string",
      "status": "string",
      "targetId": "string",
      "targetType": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-notification-resource

getNotificationsForEntity

GET /v2/admin/notification/entity/{id}
id: string
in path

id

medium: string EMAIL, IN_APP
in query

medium

pageToken: string
in query

pageToken

200 OK
TokenizedPageWithNotifications

A page of notifications

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "generator": {
        "created": "string",
        "enabled": "boolean",
        "filter": {
          "filter": "object"
        },
        "id": "string",
        "medium": "string",
        "name": "string",
        "period": "string",
        "template": {
          "content": "object",
          "contentType": "string",
          "expiration": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        }
      },
      "generatorId": "string",
      "id": "string",
      "ownerId": "string",
      "status": "string",
      "targetId": "string",
      "targetType": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

admin-transaction-resource

Admin Transaction Resource

admin-transaction-resource

getTransactions

POST /v2/admin/transactions
TransactionFilter

filter

pageSize: integer (int32)
in query

pageSize

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "bulkId": "string",
  "clientId": "string",
  "internalId": "string",
  "maxDate": "string",
  "maxDateTime": "string (date-time)",
  "minDate": "string",
  "minDateTime": "string (date-time)",
  "protocolFilter": "string",
  "sortOrder": "string",
  "sourceCode": "string",
  "statusFilter": "string",
  "statusesFilter": [
    "string"
  ],
  "templatePortfolioIds": [
    "string"
  ],
  "typeFilter": [
    "string"
  ]
}
200 OK
TokenizedPageTransaction

Page of transactions

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-transaction-resource

completeTransactions

POST /v2/admin/transactions/bgmax/complete
AutoGiroFile

file

Request Content-Types: application/json
Request Example
{
  "content": "string",
  "fileType": "string"
}
200 OK
Transaction

The created transactions

type
Transaction
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "bulkUuid": "string",
    "created": "integer (int64)",
    "errorMessage": "string",
    "externalId": "string",
    "initiated": "integer (int64)",
    "internalId": "string",
    "owner": {
      "clientId": "string",
      "customerType": "string",
      "legalIdentifierAsLong": "integer (int64)",
      "name": "string",
      "simpleId": "integer (int64)",
      "uuid": "string"
    },
    "portfolioUuid": "string",
    "protocol": "string",
    "recurringTransactionDate": "string",
    "recurringTransactionId": "string",
    "status": "string",
    "subTransactions": [
      "#/definitions/Transaction"
    ],
    "targetAccount": {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    },
    "type": "string",
    "updated": "integer (int64)",
    "userUuid": "string",
    "uuid": "string"
  }
]
admin-transaction-resource

parseTransactions

POST /v2/admin/transactions/bgmax/parse
AutoGiroFile

file

Request Content-Types: application/json
Request Example
{
  "content": "string",
  "fileType": "string"
}
200 OK
Transaction

The parsed transactions

type
Transaction
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "amount": "number (double)",
    "bulkUuid": "string",
    "created": "integer (int64)",
    "errorMessage": "string",
    "externalId": "string",
    "initiated": "integer (int64)",
    "internalId": "string",
    "owner": {
      "clientId": "string",
      "customerType": "string",
      "legalIdentifierAsLong": "integer (int64)",
      "name": "string",
      "simpleId": "integer (int64)",
      "uuid": "string"
    },
    "portfolioUuid": "string",
    "protocol": "string",
    "recurringTransactionDate": "string",
    "recurringTransactionId": "string",
    "status": "string",
    "subTransactions": [
      "#/definitions/Transaction"
    ],
    "targetAccount": {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    },
    "type": "string",
    "updated": "integer (int64)",
    "userUuid": "string",
    "uuid": "string"
  }
]
admin-transaction-resource

bulkCompleteFeeTransactions

POST /v2/admin/transactions/complete/fee/bulk
200 OK
Transaction

The generated bulk transaction

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

bulkCompleteTradeFeeTransactions

POST /v2/admin/transactions/complete/trade-fee/bulk
200 OK
Transaction

The generated bulk transaction from trade fees

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

createManualDeposit

POST /v2/admin/transactions/deposit
ManualDepositCreateRepresentation

body

Request Content-Types: application/json
Request Example
{
  "amount": "number (double)",
  "depositMessage": "string",
  "ownerId": "string",
  "portfolioId": "string",
  "type": "string"
}
200 OK
Transaction

The created transaction

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

transactionBulkExport

POST /v2/admin/transactions/export/bulk
200 OK
Transaction

The exported transactions (transaction id)

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

getInvoicesForTransactions

POST /v2/admin/transactions/invoice

transactionIds

string
Request Content-Types: application/json
Request Example
[
  "string"
]
200 OK
Invoice

Invoices

type
Invoice
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "accountNumber": "string",
    "adjustedAmount": "number (double)",
    "amount": "number (double)",
    "created": "string",
    "dueDate": "string",
    "invoiceNumber": "integer (int32)",
    "legalIdentifier": "integer (int64)",
    "logItemId": "string",
    "name": "string",
    "ownerId": "string",
    "paymentAccount": "string",
    "paymentId": "string",
    "periodEndDate": "string",
    "periodStartDate": "string",
    "portfolioId": "string",
    "portfolioName": "string",
    "transactionId": "string",
    "transactionStatus": "string",
    "transferredAmount": "number (double)",
    "vat": "number (double)"
  }
]
admin-transaction-resource

listTransactions

GET /v2/admin/transactions/list
page: integer (int32) 0
in query

page

protocolFilter: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
in query

protocolFilter

typeFilter: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
in query

typeFilter

statusFilter: string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
in query

statusFilter

200 OK
InternalPageRepresentationTransaction

Page of transactions

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-transaction-resource

listTransactionsForUser

GET /v2/admin/transactions/list/user/{userId}
userId: string
in path

userId

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationTransaction

Page of transactions

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-transaction-resource

listTransactionsForPortfolio

GET /v2/admin/transactions/list/{portfolioId}
portfolioId: string
in path

portfolioId

page: integer (int32) 0
in query

page

200 OK
InternalPageRepresentationTransaction

Page of transactions

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-transaction-resource

getTransaction

GET /v2/admin/transactions/{transactionId}
transactionId: string
in path

transactionId

200 OK
Transaction

A transaction

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

manualTransactionCompleted

POST /v2/admin/transactions/{transactionId}/complete
transactionId: string
in path

transactionId

200 OK
Transaction

The completed transaction

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

manualTransactionExported

POST /v2/admin/transactions/{transactionId}/export
transactionId: string
in path

transactionId

200 OK
Transaction

The exported transaction

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}
admin-transaction-resource

getInvoiceForTransaction

GET /v2/admin/transactions/{transactionId}/invoice
transactionId: string
in path

transactionId

200 OK
Invoice

An invoice

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountNumber": "string",
  "adjustedAmount": "number (double)",
  "amount": "number (double)",
  "created": "string",
  "dueDate": "string",
  "invoiceNumber": "integer (int32)",
  "legalIdentifier": "integer (int64)",
  "logItemId": "string",
  "name": "string",
  "ownerId": "string",
  "paymentAccount": "string",
  "paymentId": "string",
  "periodEndDate": "string",
  "periodStartDate": "string",
  "portfolioId": "string",
  "portfolioName": "string",
  "transactionId": "string",
  "transactionStatus": "string",
  "transferredAmount": "number (double)",
  "vat": "number (double)"
}

admin-notification-generator-resource

Admin Notification Generator Resource

admin-notification-generator-resource

getNotificationGenerators

GET /v2/admin/notification/generator
pageToken: string
in query

pageToken

200 OK
TokenizedPageWithNotificationGenerators

A page of generators

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "filter": {
        "filter": "object"
      },
      "id": "string",
      "medium": "string",
      "name": "string",
      "period": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-notification-generator-resource

create

POST /v2/admin/notification/generator
CreateData

createData

Request Content-Types: application/json
Request Example
{
  "content": "object",
  "contentType": "string",
  "expiration": "string",
  "name": "string",
  "type": "string"
}
200 OK
NotificationGenerator

The created generator

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "enabled": "boolean",
  "filter": {
    "filter": "object"
  },
  "id": "string",
  "medium": "string",
  "name": "string",
  "period": "string",
  "template": {
    "content": "object",
    "contentType": "string",
    "expiration": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
}
admin-notification-generator-resource

testQuery

POST /v2/admin/notification/generator/query
NotificationFilter

filter

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "filter": "object"
}
200 OK
TokenizedPageWithNotificationHits

Page of result items for the provided notification query

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "customerId": "string",
      "customerType": "string",
      "targetExternalId": "string",
      "targetId": "string",
      "targetName": "string",
      "targetType": "string",
      "templateValues": "object"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-notification-generator-resource

update

PATCH /v2/admin/notification/generator/{id}
NotificationGeneratorPatch

patch

id: string
in path

id

Request Content-Types: application/json
Request Example
{
  "enabled": {
    "action": "string",
    "value": "boolean"
  },
  "filter": {
    "action": "string",
    "value": {
      "filter": "object"
    }
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "period": {
    "action": "string",
    "value": "string"
  }
}
200 OK
NotificationGenerator

The updated generator

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "enabled": "boolean",
  "filter": {
    "filter": "object"
  },
  "id": "string",
  "medium": "string",
  "name": "string",
  "period": "string",
  "template": {
    "content": "object",
    "contentType": "string",
    "expiration": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
}
admin-notification-generator-resource

disable

PATCH /v2/admin/notification/generator/{id}/disable
id: string
in path

id

200 OK
NotificationGenerator

The updated generator

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "enabled": "boolean",
  "filter": {
    "filter": "object"
  },
  "id": "string",
  "medium": "string",
  "name": "string",
  "period": "string",
  "template": {
    "content": "object",
    "contentType": "string",
    "expiration": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
}
admin-notification-generator-resource

enable

PATCH /v2/admin/notification/generator/{id}/enable
id: string
in path

id

200 OK
NotificationGenerator

The updated generator

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "created": "string",
  "enabled": "boolean",
  "filter": {
    "filter": "object"
  },
  "id": "string",
  "medium": "string",
  "name": "string",
  "period": "string",
  "template": {
    "content": "object",
    "contentType": "string",
    "expiration": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
}
admin-notification-generator-resource

trigger

POST /v2/admin/notification/generator/{id}/trigger
id: string
in path

id

200 OK
NotificationGeneratorTriggerResponse

The update generator

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "numberOfTriggers": "integer (int32)"
}

admin-referral-payout-resource

Admin Referral Payout Resource

admin-referral-payout-resource

getReferralPayoutConfiguration

GET /v2/admin/referral/payout/config
200 OK
CompletableFuture«ReferralPayoutConfiguration»

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-referral-payout-resource

makePayoutForCustomer

POST /v2/admin/referral/payout/customer/{customerId}
customerId: string
in path

customerId

200 OK
ReferralPayoutResult

OK

type
ReferralPayoutResult
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "logItemId": "string",
    "message": "string",
    "orderId": "string",
    "portfolioId": "string",
    "referralPayoutPayload": {
      "payoutAmount": "number (double)",
      "payoutLeftover": "number (double)",
      "payoutMethod": "string",
      "periodEnd": "string",
      "periodStart": "string"
    },
    "status": "string",
    "transactionId": "string"
  }
]
admin-referral-payout-resource

makePayoutForPortfolio

POST /v2/admin/referral/payout/portfolio/{portfolioId}
portfolioId: string
in path

portfolioId

200 OK
ReferralPayoutResult

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "logItemId": "string",
  "message": "string",
  "orderId": "string",
  "portfolioId": "string",
  "referralPayoutPayload": {
    "payoutAmount": "number (double)",
    "payoutLeftover": "number (double)",
    "payoutMethod": "string",
    "periodEnd": "string",
    "periodStart": "string"
  },
  "status": "string",
  "transactionId": "string"
}
admin-referral-payout-resource

registerPayoutForPortfolio

POST /v2/admin/referral/payout/register/{portfolioId}
customerId: string
in path

customerId

200 OK
ReferralPayoutResult

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "logItemId": "string",
  "message": "string",
  "orderId": "string",
  "portfolioId": "string",
  "referralPayoutPayload": {
    "payoutAmount": "number (double)",
    "payoutLeftover": "number (double)",
    "payoutMethod": "string",
    "periodEnd": "string",
    "periodStart": "string"
  },
  "status": "string",
  "transactionId": "string"
}

admin-tracking-resource

Admin Tracking Resource

admin-tracking-resource

getLatestTrackingValues

GET /v2/admin/tracking/latest
200 OK
TrackingLogValue

List of tracking values

type
TrackingLogValue
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "type": "string",
    "value": {
      "dateTime": "string",
      "value": "number (double)"
    }
  }
]
admin-tracking-resource

getLatestTrackingValues

GET /v2/admin/tracking/series
type: string NUM_USERS, NUM_USERS_W_VALUE, NUM_USERS_W_RECURRING, NUM_PORTFOLIOS, NUM_PORTFOLIOS_W_VALUE, AUM, ASSET_STORAGE_VALUE, ASSET_STORAGE_CASH_VALUE
in query

type

client_id: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
in query

client_id

200 OK
TrackingLogTimeSeries

Tracking value history

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "type": "string",
  "values": [
    {
      "dateTime": "string",
      "value": "number (double)"
    }
  ]
}
admin-tracking-resource

getUserStats

GET /v2/admin/tracking/user/statistics
from_date: string
in query

from_date

200 OK
UserStatistics

User statistics

type
UserStatistics
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "clientId": "string",
    "created": "string",
    "deleted": "boolean",
    "portfolioCount": "number (double)",
    "recurringTransactionsCount": "number (double)",
    "totalPortfolioValue": "number (double)",
    "uuid": "string"
  }
]

admin-transaction-swish-resource

Admin Transaction Swish Resource

admin-transaction-swish-resource

getSwishTransaction

GET /v2/admin/transactions/swish/{transactionId}
transactionId: string
in path

transactionId

200 OK
SwishTransaction

A swish transaction

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "portfolio": {
    "accountType": "string",
    "assets": [
      {
        "amount": "number (double)",
        "assetId": "string"
      }
    ],
    "bearLoss": "string",
    "deleted": "boolean",
    "endDate": "integer (int64)",
    "errors": [
      "string"
    ],
    "fee": {
      "fixedTradeFee": {
        "exchangeFee": "number (double)",
        "tradeFee": "number (double)"
      },
      "managementFee": "number (double)",
      "noValueBasedDiscount": "boolean",
      "safekeepingFee": "number (double)",
      "tradeFeesNotIncluded": "boolean",
      "valueBasedDiscount": "number (double)",
      "vat": "number (double)"
    },
    "feeDiscounts": [
      {
        "canceled": "string",
        "created": "string",
        "fee": {
          "fixedTradeFee": {
            "exchangeFee": "number (double)",
            "tradeFee": "number (double)"
          },
          "managementFee": "number (double)",
          "noValueBasedDiscount": "boolean",
          "safekeepingFee": "number (double)",
          "tradeFeesNotIncluded": "boolean",
          "valueBasedDiscount": "number (double)",
          "vat": "number (double)"
        },
        "id": "string",
        "periodEnd": "string",
        "periodStart": "string"
      }
    ],
    "goalAmount": "number (double)",
    "id": "string",
    "initialDeposit": "number (double)",
    "investmentPurpose": "string",
    "investmentStrategyType": "string",
    "lastUpdate": "integer (int64)",
    "monthlyDeposit": "number (double)",
    "monthlyPayout": "number (double)",
    "name": "string",
    "ownerId": "string",
    "parent": "boolean",
    "parentId": "string",
    "payoutEndDate": "integer (int64)",
    "portfolioIndex": "integer (int32)",
    "riskLevel": "string",
    "sri": "boolean",
    "startDate": "integer (int64)",
    "state": {
      "depositBalance": "number (double)",
      "depositTriggers": [
        {
          "amount": "number (double)",
          "recurring": "boolean",
          "sourceId": "string",
          "triggerType": "string"
        }
      ],
      "feeWithdrawalBalance": "number (double)",
      "fullWithdrawal": "boolean",
      "hasError": "boolean",
      "pendingDeposit": "boolean",
      "pendingFeeWithdrawal": "boolean",
      "pendingRealloc": "boolean",
      "pendingTrade": "boolean",
      "pendingWithdrawal": "boolean",
      "reallocTriggerType": "string",
      "tradeGroupIdentifier": "string",
      "tradeSubState": "string",
      "withdrawalBalance": "number (double)"
    },
    "templatePortfolio": {
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "estimatedReturn": "number (double)",
      "id": "string",
      "lastDistributionChange": "integer (int64)",
      "lastDistributionRefresh": "integer (int64)",
      "maxDD": "number (double)",
      "name": "string",
      "strategyIndex": "string",
      "targetDistribution": {
        "alternative": "number (double)",
        "bonds": "number (double)",
        "commodities": "number (double)",
        "stocks": "number (double)"
      },
      "targetVar": "number (double)",
      "trackingPortfolio": "string",
      "type": "string",
      "var": "number (double)",
      "volatility": "number (double)"
    },
    "templatePortfolioActionStatus": "string",
    "wallpaper": {
      "id": "string",
      "protocol": "string"
    }
  },
  "transaction": {
    "amount": "number (double)",
    "bulkUuid": "string",
    "created": "integer (int64)",
    "errorMessage": "string",
    "externalId": "string",
    "initiated": "integer (int64)",
    "internalId": "string",
    "owner": {
      "clientId": "string",
      "customerType": "string",
      "legalIdentifierAsLong": "integer (int64)",
      "name": "string",
      "simpleId": "integer (int64)",
      "uuid": "string"
    },
    "portfolioUuid": "string",
    "protocol": "string",
    "recurringTransactionDate": "string",
    "recurringTransactionId": "string",
    "status": "string",
    "subTransactions": [
      "#/definitions/Transaction"
    ],
    "targetAccount": {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    },
    "type": "string",
    "updated": "integer (int64)",
    "userUuid": "string",
    "uuid": "string"
  },
  "user": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}
admin-transaction-swish-resource

updateSwishTransaction

PATCH /v2/admin/transactions/swish/{transactionId}
SwishTransactionUpdate

update

transactionId: string
in path

transactionId

Request Content-Types: application/json
Request Example
{
  "bankTransactionIdentifier": "string",
  "message": "string",
  "paymentRequestToken": "string",
  "status": "string"
}
200 OK
Transaction

The updated swish transaction

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    "#/definitions/Transaction"
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}

admin-async-task-resource

Admin Async Task Resource

admin-async-task-resource

createTask

POST /v2/admin/async-task
AsyncTaskCreate

createData

Request Content-Types: application/json
Request Example
{
  "payload": "object",
  "type": "string"
}
200 OK
CompletableFuture«AsyncTask«object»»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-async-task-resource

getTasks

POST /v2/admin/async-task/list

pageToken

Request Content-Types: application/json
Request Example
"string"
200 OK
CompletableFuture«TokenizedPage«AsyncTask«object»»»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-async-task-resource

getTask

GET /v2/admin/async-task/{taskId}
taskId: string
in path

taskId

200 OK
CompletableFuture«AsyncTask«object»»

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-async-task-resource

cancelTask

POST /v2/admin/async-task/{taskId}/cancel
taskId: string
in path

taskId

200 OK
CompletableFuture«AsyncTask«object»»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-async-task-resource

getTaskResult

GET /v2/admin/async-task/{taskId}/result/{resultType}

pageToken

taskId: string
in path

taskId

resultType: string
in path

resultType

Request Content-Types: application/json
Request Example
"string"
200 OK
CompletableFuture«AsyncTaskResultSet«object»»

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
admin-async-task-resource

startTask

POST /v2/admin/async-task/{taskId}/start
taskId: string
in path

taskId

200 OK
CompletableFuture«AsyncTask«object»»

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)

admin-recommendations-resource

Admin Recommendations Resource

admin-recommendations-resource

uploadRecommendations

POST /v2/admin/recommendations/upload
CSVDataContainer

body

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
GenericResponse

Result from upload

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}

admin-role-resource

Admin Role Resource

admin-role-resource

getAdmins

GET /v2/admin/admins
200 OK
Admin

A list of admins

type
Admin
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "authorities": [
      "string"
    ],
    "disabled": "boolean",
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "personalNumber": "string",
    "phone": "string",
    "uuid": "string"
  }
]
admin-role-resource

createAdmin

POST /v2/admin/admins
Admin

adminData

Request Content-Types: application/json
Request Example
{
  "authorities": [
    "string"
  ],
  "disabled": "boolean",
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "personalNumber": "string",
  "phone": "string",
  "uuid": "string"
}
200 OK
Admin

The created admin

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "disabled": "boolean",
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "personalNumber": "string",
  "phone": "string",
  "uuid": "string"
}
admin-role-resource

getAdmin

GET /v2/admin/admins/{adminUuid}
adminUuid: string
in path

adminUuid

200 OK
Admin

An admin

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "disabled": "boolean",
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "personalNumber": "string",
  "phone": "string",
  "uuid": "string"
}
admin-role-resource

updateAdmin

PATCH /v2/admin/admins/{adminUuid}
AdminPatch

patch

adminUuid: string
in path

adminUuid

Request Content-Types: application/json
Request Example
{
  "authorities": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "disabled": {
    "action": "string",
    "value": "boolean"
  },
  "email": {
    "action": "string",
    "value": "string"
  },
  "imageUrl": {
    "action": "string",
    "value": "string"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "phone": {
    "action": "string",
    "value": "string"
  }
}
200 OK
Admin

The updated admin

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "disabled": "boolean",
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "personalNumber": "string",
  "phone": "string",
  "uuid": "string"
}

admin-auth-cert-resource

Admin Auth Cert Resource

admin-auth-cert-resource

getCerts

GET /v2/admin/cert-auth
200 OK
AuthCertificate

List of cert data entries

type
AuthCertificate
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "authorities": [
      "string"
    ],
    "certData": "string",
    "certId": "string",
    "clientIds": [
      "string"
    ],
    "created": "integer (int64)",
    "name": "string"
  }
]
admin-auth-cert-resource

createCert

POST /v2/admin/cert-auth
AuthCertificate

data

Request Content-Types: application/json
Request Example
{
  "authorities": [
    "string"
  ],
  "certData": "string",
  "certId": "string",
  "clientIds": [
    "string"
  ],
  "created": "integer (int64)",
  "name": "string"
}
200 OK
AuthCertificate

The created certificate

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "certData": "string",
  "certId": "string",
  "clientIds": [
    "string"
  ],
  "created": "integer (int64)",
  "name": "string"
}
admin-auth-cert-resource

updateCert

POST /v2/admin/cert-auth/{certId}
AuthCertificate

data

certId: string
in path

certId

Request Content-Types: application/json
Request Example
{
  "authorities": [
    "string"
  ],
  "certData": "string",
  "certId": "string",
  "clientIds": [
    "string"
  ],
  "created": "integer (int64)",
  "name": "string"
}
200 OK
AuthCertificate

The updated certificate

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "certData": "string",
  "certId": "string",
  "clientIds": [
    "string"
  ],
  "created": "integer (int64)",
  "name": "string"
}
admin-auth-cert-resource

deleteCert

DELETE /v2/admin/cert-auth/{certId}
certId: string
in path

certId

200 OK
AuthCertificate

The deleted certificate

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "authorities": [
    "string"
  ],
  "certData": "string",
  "certId": "string",
  "clientIds": [
    "string"
  ],
  "created": "integer (int64)",
  "name": "string"
}

admin-notification-template-resource

Admin Notification Template Resource

admin-notification-template-resource

getNotificationTemplates

GET /v2/admin/notification/template
pageToken: string
in query

pageToken

200 OK
TokenizedPageWithNotificationTemplates

A page of templates

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "content": "object",
      "contentType": "string",
      "expiration": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-notification-template-resource

create

POST /v2/admin/notification/template
CreateData

createData

Request Content-Types: application/json
Request Example
{
  "content": "object",
  "contentType": "string",
  "expiration": "string",
  "name": "string",
  "type": "string"
}
200 OK
NotificationTemplate

The created template

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": "object",
  "contentType": "string",
  "expiration": "string",
  "id": "string",
  "name": "string",
  "type": "string"
}
admin-notification-template-resource

update

PATCH /v2/admin/notification/template/{id}
NotificationTemplatePatch

patch

id: string
in path

id

Request Content-Types: application/json
Request Example
{
  "content": {
    "action": "string",
    "value": "object"
  },
  "contentType": {
    "action": "string",
    "value": "string"
  },
  "expiration": {
    "action": "string",
    "value": "string"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "type": {
    "action": "string",
    "value": "string"
  }
}
200 OK
NotificationTemplate

The updated template

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": "object",
  "contentType": "string",
  "expiration": "string",
  "id": "string",
  "name": "string",
  "type": "string"
}

admin-asset-resource

Admin Asset Resource

admin-asset-resource

createAsset

POST /v2/admin/assets
AssetCreateData

body

Request Content-Types: application/json
Request Example
{
  "activeManagement": {
    "action": "string",
    "value": "boolean"
  },
  "assetClass": {
    "action": "string",
    "value": "string"
  },
  "aum": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "number (double)"
    }
  },
  "aumCurrency": {
    "action": "string",
    "value": "string"
  },
  "benchmarkName": {
    "action": "string",
    "value": "string"
  },
  "categorySwe": {
    "action": "string",
    "value": "string"
  },
  "ceo": {
    "action": "string",
    "value": "string"
  },
  "commentsSwe": {
    "action": "string",
    "value": "string"
  },
  "country": {
    "action": "string",
    "value": "string"
  },
  "currency": "string",
  "currencyAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "currencyExchangeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "currencyHedged": {
    "action": "string",
    "value": "boolean"
  },
  "dataSourceExchangeCode": {
    "action": "string",
    "value": "string"
  },
  "descStrategySwe": {
    "action": "string",
    "value": "string"
  },
  "descSwe": {
    "action": "string",
    "value": "string"
  },
  "dividendCurrency": {
    "action": "string",
    "value": "string"
  },
  "dividendFrequency": {
    "action": "string",
    "value": "string"
  },
  "dividendYield": {
    "action": "string",
    "value": "number (double)"
  },
  "exchangeCode": "string",
  "geoAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "geography": {
    "action": "string",
    "value": "string"
  },
  "holdingsAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "inceptionDate": {
    "action": "string",
    "value": "string"
  },
  "index": {
    "action": "string",
    "value": "integer (int32)"
  },
  "isActiveModel": {
    "action": "string",
    "value": "boolean"
  },
  "isActivePlatform": {
    "action": "string",
    "value": "boolean"
  },
  "isCollectingData": {
    "action": "string",
    "value": "boolean"
  },
  "isTradeStopped": {
    "action": "string",
    "value": "boolean"
  },
  "isin": "string",
  "issuingCompany": {
    "action": "string",
    "value": "string"
  },
  "kiidUrl": {
    "action": "string",
    "value": "string"
  },
  "market": {
    "action": "string",
    "value": "string"
  },
  "metricBeta": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPe": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPs": {
    "action": "string",
    "value": "number (double)"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "notes": {
    "action": "string",
    "value": "string"
  },
  "numEmployees": {
    "action": "string",
    "value": "integer (int32)"
  },
  "numberOfHoldings": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "integer (int32)"
    }
  },
  "orderRoute": {
    "action": "string",
    "value": "string"
  },
  "replicationStrategy": {
    "action": "string",
    "value": "string"
  },
  "riskFactor": {
    "action": "string",
    "value": "string"
  },
  "riskLevel": {
    "action": "string",
    "value": "integer (int32)"
  },
  "sectors": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "sharesTotal": {
    "action": "string",
    "value": "integer (int32)"
  },
  "shortName": {
    "action": "string",
    "value": "string"
  },
  "sri": {
    "action": "string",
    "value": "boolean"
  },
  "ter": {
    "action": "string",
    "value": "number (double)"
  },
  "ticker": "string",
  "tradeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "type": "string",
  "ucits": {
    "action": "string",
    "value": "boolean"
  },
  "url": {
    "action": "string",
    "value": "string"
  }
}
200 OK
Asset

The created asset

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-asset-resource

updateAssetsESGData

PATCH /v2/admin/assets/esg
PatchSet«AssetESGDataPatch»

patchSet

Request Content-Types: application/json
Request Example
{
  "patches": [
    {
      "patch": {
        "msciEsgDataDate": {
          "action": "string",
          "value": "string"
        },
        "msciEsgDataPresent": {
          "action": "string",
          "value": "boolean"
        },
        "msciEsgQualityScore": {
          "action": "string",
          "value": "number (double)"
        },
        "msciEsgQualityScorePctlGlobal": {
          "action": "string",
          "value": "number (double)"
        },
        "msciEsgQualityScorePctlPeer": {
          "action": "string",
          "value": "number (double)"
        },
        "msciEsgRating": {
          "action": "string",
          "value": "string"
        },
        "msciSustainableImpactPct": {
          "action": "string",
          "value": "number (double)"
        },
        "msciWaCO2i": {
          "action": "string",
          "value": "number (double)"
        }
      },
      "uuid": "string"
    }
  ]
}
200 OK
Asset

The updated asset

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-asset-resource

exportETFAssets

GET /v2/admin/assets/export/etf
200 OK

CSV stream of all ETFs

type
string
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
"string"
admin-asset-resource

exportStockAssets

GET /v2/admin/assets/export/stock
200 OK

CSV stream of all stocks

type
string
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
"string"
admin-asset-resource

getAssetByIdentifier

POST /v2/admin/assets/identifier
AssetValueIdentifier

identifier

Request Content-Types: application/json
Request Example
{
  "currency": "string",
  "ticker": "string"
}
200 OK
Asset

An asset

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-asset-resource

getAssets

POST /v2/admin/assets/list

assetIds

string
Request Content-Types: application/json
Request Example
[
  "string"
]
200 OK
Asset

List of assets

type
Asset
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "activeManagement": "boolean",
    "added": "string",
    "assetClass": "string",
    "aum": "number (double)",
    "aumCurrency": "string",
    "aumDate": "string",
    "baseValue": {
      "lastClosing": "number (double)",
      "lastClosingDate": "string"
    },
    "benchmarkName": "string",
    "categorySwe": "string",
    "ceo": "string",
    "commentsSwe": "string",
    "country": "string",
    "currency": "string",
    "currencyAllocation": "object",
    "currencyAllocationDate": "string",
    "currencyExchangeFeeDisabled": "boolean",
    "currencyHedged": "boolean",
    "dataSourceExchangeCode": "string",
    "descriptionSwe": "string",
    "dividendCurrency": "string",
    "dividendFrequency": "string",
    "dividendYield": "number (double)",
    "exchangeCode": "string",
    "geoAllocation": "object",
    "geoAllocationDate": "string",
    "geography": "string",
    "holdingsAllocation": "object",
    "holdingsAllocationDate": "string",
    "id": "string",
    "inceptionDate": "string",
    "index": "integer (int32)",
    "isActiveModel": "boolean",
    "isActivePlatform": "boolean",
    "isCollectingData": "boolean",
    "isTradeStopped": "boolean",
    "isin": "string",
    "issuingCompany": "string",
    "kiidUrl": "string",
    "market": "string",
    "metricBeta": "number (double)",
    "metricPe": "number (double)",
    "metricPs": "number (double)",
    "msciEsgDataDate": "string",
    "msciEsgDataPresent": "boolean",
    "msciEsgQualityScore": "number (double)",
    "msciEsgQualityScorePctlGlobal": "number (double)",
    "msciEsgQualityScorePctlPeer": "number (double)",
    "msciEsgRating": "string",
    "msciSustainableImpactPct": "number (double)",
    "msciWaCO2i": "number (double)",
    "name": "string",
    "notes": "string",
    "numEmployees": "integer (int32)",
    "numberOfHoldings": "integer (int32)",
    "numberOfHoldingsDate": "string",
    "orderRoute": "string",
    "replicationStrategy": "string",
    "riskFactor": "string",
    "riskLevel": "integer (int32)",
    "sectors": [
      "string"
    ],
    "sharesTotal": "integer (int32)",
    "shortName": "string",
    "simpleId": "integer (int64)",
    "sri": "boolean",
    "strategyDescriptionSwe": "string",
    "tags": [
      "string"
    ],
    "ter": "number (double)",
    "ticker": "string",
    "tradeFeeDisabled": "boolean",
    "type": "string",
    "ucits": "boolean",
    "url": "string",
    "value": {
      "buy": "number (double)",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "fiveYears": "number (double)",
      "last": "number (double)",
      "lastClosing": "number (double)",
      "lastClosingDate": "string",
      "lastPeriodUpdate": "string",
      "lastValueUpdated": "string",
      "oneMonth": "number (double)",
      "oneYear": "number (double)",
      "sell": "number (double)",
      "sixMonths": "number (double)",
      "thisYear": "number (double)",
      "threeMonths": "number (double)",
      "threeYears": "number (double)"
    }
  }
]
admin-asset-resource

getAssets

POST /v2/admin/assets/query
AssetFilter

assetFilter

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
in query

currency

pageSize: integer (int32)
in query

pageSize

pageToken: string
in query

pageToken

Request Content-Types: application/json
Request Example
{
  "active": "boolean",
  "activeModel": "boolean",
  "activePlatform": "boolean",
  "assetClass": [
    "string"
  ],
  "assetTypes": [
    "string"
  ],
  "clientId": "string",
  "country": [
    "string"
  ],
  "discountConfig": "string",
  "geography": [
    "string"
  ],
  "hasDivdend": "boolean",
  "invertOrder": "boolean",
  "investmentStrategyType": "string",
  "isins": [
    "string"
  ],
  "market": [
    "string"
  ],
  "order": "string",
  "sector": [
    "string"
  ],
  "sri": [
    "boolean"
  ],
  "tags": [
    "string"
  ]
}
200 OK
TokenizedPageWithAssets

List of assets

type
TokenizedPageWithAssets
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "content": [
      {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      }
    ],
    "first": "boolean",
    "last": "boolean",
    "nextToken": "string",
    "size": "integer (int32)",
    "token": "string",
    "totalSize": "integer (int32)"
  }
]
admin-asset-resource

getAvailableTags

POST /v2/admin/assets/tags
AssetFilter

assetFilter

Request Content-Types: application/json
Request Example
{
  "active": "boolean",
  "activeModel": "boolean",
  "activePlatform": "boolean",
  "assetClass": [
    "string"
  ],
  "assetTypes": [
    "string"
  ],
  "clientId": "string",
  "country": [
    "string"
  ],
  "discountConfig": "string",
  "geography": [
    "string"
  ],
  "hasDivdend": "boolean",
  "invertOrder": "boolean",
  "investmentStrategyType": "string",
  "isins": [
    "string"
  ],
  "market": [
    "string"
  ],
  "order": "string",
  "sector": [
    "string"
  ],
  "sri": [
    "boolean"
  ],
  "tags": [
    "string"
  ]
}
200 OK

List of available tags

type
string[]
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  "string"
]
admin-asset-resource

uploadEFTAssets

POST /v2/admin/assets/upload/etf
CSVDataContainer

body

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
AssetUploadResultRepresentations

Result from upload

type
AssetUploadResultRepresentations
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "assetId": "string",
    "assetName": "string",
    "error": "string"
  }
]
admin-asset-resource

uploadStockAssets

POST /v2/admin/assets/upload/stock
CSVDataContainer

body

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
AssetUploadResultRepresentations

Result from upload

type
AssetUploadResultRepresentations
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "assetId": "string",
    "assetName": "string",
    "error": "string"
  }
]
admin-asset-resource

getAssetValue

POST /v2/admin/assets/value
Asset

body

Request Content-Types: application/json
Request Example
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
200 OK
InternalValueRepresentation

Last known value of asset

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "buy": "number (double)",
  "currency": "string",
  "currencyExchangeRate": "number (double)",
  "last": "number (double)",
  "lastValueUpdated": "string",
  "sell": "number (double)"
}
admin-asset-resource

getAsset

GET /v2/admin/assets/{assetId}
assetId: string
in path

assetId

200 OK
Asset

An asset

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-asset-resource

updateAsset

PATCH /v2/admin/assets/{assetId}
AssetPatch

body

assetId: string
in path

assetId

Request Content-Types: application/json
Request Example
{
  "activeManagement": {
    "action": "string",
    "value": "boolean"
  },
  "assetClass": {
    "action": "string",
    "value": "string"
  },
  "aum": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "number (double)"
    }
  },
  "aumCurrency": {
    "action": "string",
    "value": "string"
  },
  "benchmarkName": {
    "action": "string",
    "value": "string"
  },
  "categorySwe": {
    "action": "string",
    "value": "string"
  },
  "ceo": {
    "action": "string",
    "value": "string"
  },
  "commentsSwe": {
    "action": "string",
    "value": "string"
  },
  "country": {
    "action": "string",
    "value": "string"
  },
  "currencyAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "currencyExchangeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "currencyHedged": {
    "action": "string",
    "value": "boolean"
  },
  "dataSourceExchangeCode": {
    "action": "string",
    "value": "string"
  },
  "descStrategySwe": {
    "action": "string",
    "value": "string"
  },
  "descSwe": {
    "action": "string",
    "value": "string"
  },
  "dividendCurrency": {
    "action": "string",
    "value": "string"
  },
  "dividendFrequency": {
    "action": "string",
    "value": "string"
  },
  "dividendYield": {
    "action": "string",
    "value": "number (double)"
  },
  "geoAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "geography": {
    "action": "string",
    "value": "string"
  },
  "holdingsAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "inceptionDate": {
    "action": "string",
    "value": "string"
  },
  "index": {
    "action": "string",
    "value": "integer (int32)"
  },
  "isActiveModel": {
    "action": "string",
    "value": "boolean"
  },
  "isActivePlatform": {
    "action": "string",
    "value": "boolean"
  },
  "isCollectingData": {
    "action": "string",
    "value": "boolean"
  },
  "isTradeStopped": {
    "action": "string",
    "value": "boolean"
  },
  "issuingCompany": {
    "action": "string",
    "value": "string"
  },
  "kiidUrl": {
    "action": "string",
    "value": "string"
  },
  "market": {
    "action": "string",
    "value": "string"
  },
  "metricBeta": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPe": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPs": {
    "action": "string",
    "value": "number (double)"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "notes": {
    "action": "string",
    "value": "string"
  },
  "numEmployees": {
    "action": "string",
    "value": "integer (int32)"
  },
  "numberOfHoldings": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "integer (int32)"
    }
  },
  "orderRoute": {
    "action": "string",
    "value": "string"
  },
  "replicationStrategy": {
    "action": "string",
    "value": "string"
  },
  "riskFactor": {
    "action": "string",
    "value": "string"
  },
  "riskLevel": {
    "action": "string",
    "value": "integer (int32)"
  },
  "sectors": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "sharesTotal": {
    "action": "string",
    "value": "integer (int32)"
  },
  "shortName": {
    "action": "string",
    "value": "string"
  },
  "sri": {
    "action": "string",
    "value": "boolean"
  },
  "ter": {
    "action": "string",
    "value": "number (double)"
  },
  "tradeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "ucits": {
    "action": "string",
    "value": "boolean"
  },
  "url": {
    "action": "string",
    "value": "string"
  }
}
200 OK
Asset

The updated asset

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-asset-resource

getAssetValueHistory

POST /v2/admin/assets/{assetId}/history
InternalAssetHistoryRequestRepresentation

body

assetId: string
in path

assetId

Request Content-Types: application/json
Request Example
{
  "currency": "string",
  "endDate": "string",
  "startDate": "string"
}
200 OK
InternalValueHistoryRepresentation

History of asset

type
InternalValueHistoryRepresentation
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "currency": "string",
    "endDate": "string",
    "startDate": "string",
    "values": [
      {
        "dateTime": "string",
        "value": "number (double)"
      }
    ]
  }
]
admin-asset-resource

splitAsset

POST /v2/admin/assets/{assetId}/split
assetId: string
in path

assetId

multiplier: string
in query

multiplier

splitDate: string
in query

splitDate

200 OK
Asset

Split an asset

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}
admin-asset-resource

getAssetTags

GET /v2/admin/assets/{assetId}/tags
assetId: string
in path

assetId

200 OK
AssetTag

List of tags for asset

type
AssetTag
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "assetId": "string",
    "id": "string",
    "source": "string",
    "tagName": "string"
  }
]
admin-asset-resource

createAssetTag

POST /v2/admin/assets/{assetId}/tags
AssetTagCreateData

data

assetId: string
in path

assetId

Request Content-Types: application/json
Request Example
{
  "tagName": "string"
}
200 OK
AssetTag

The created tag

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "assetId": "string",
  "id": "string",
  "source": "string",
  "tagName": "string"
}
admin-asset-resource

deleteAssetTag

DELETE /v2/admin/assets/{assetId}/tags/{tagId}
assetId: string
in path

assetId

tagId: string
in path

tagId

200 OK
GenericResponse

OK

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-asset-resource

getAssetValue

GET /v2/admin/assets/{assetId}/value
assetId: string
in path

assetId

convertCurrency: boolean true
in query

convertCurrency

200 OK
InternalValueRepresentation

Last known value of asset

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "buy": "number (double)",
  "currency": "string",
  "currencyExchangeRate": "number (double)",
  "last": "number (double)",
  "lastValueUpdated": "string",
  "sell": "number (double)"
}

admin-recurring-transactions-admin-resource

Admin Recurring Transactions Admin Resource

admin-recurring-transactions-admin-resource

getTransactions

GET /v2/admin/recurring-transactions
page: integer (int32) 0
in query

page

type: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
in query

type

protocol: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
in query

protocol

status: string
in query

status

200 OK
InternalPageRepresentationRecurringTransaction

A page of recurring transactions

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-recurring-transactions-admin-resource

generateWithdrawalRequests

GET /v2/admin/recurring-transactions/auto-giro/withdrawal-requests
200 OK
InputStreamResource

An autogiro withdrawal requests file

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}

admin-resource-resource

Admin Resource Resource

admin-resource-resource

listDocumentGroups

GET /v2/admin/resources/document-groups
200 OK
InternalDocumentGroupRepresentation

All document groups

type
InternalDocumentGroupRepresentation
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "documents": [
      {
        "category": "string",
        "contentType": "string",
        "created": "string",
        "deprecated": "boolean",
        "description": "string",
        "fileName": "string",
        "hash": "string",
        "hashAlg": "string",
        "title": "string",
        "type": "string",
        "typeMeta": "object",
        "uuid": "string"
      }
    ],
    "groupId": {
      "groupId": "string",
      "groupType": "string",
      "major": "integer (int32)",
      "minor": "integer (int32)"
    },
    "groupType": "string",
    "majorVersion": "integer (int32)",
    "minorVersion": "integer (int32)",
    "uuid": "string"
  }
]
admin-resource-resource

createDocumentGroup

POST /v2/admin/resources/document-groups
InternalDocumentGroupUpdateRepresentation

data

Request Content-Types: application/json
Request Example
{
  "documents": [
    "string"
  ],
  "newMajor": "boolean",
  "type": "string"
}
200 OK
InternalDocumentGroupRepresentation

The created document group

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "documents": [
    {
      "category": "string",
      "contentType": "string",
      "created": "string",
      "deprecated": "boolean",
      "description": "string",
      "fileName": "string",
      "hash": "string",
      "hashAlg": "string",
      "title": "string",
      "type": "string",
      "typeMeta": "object",
      "uuid": "string"
    }
  ],
  "groupId": {
    "groupId": "string",
    "groupType": "string",
    "major": "integer (int32)",
    "minor": "integer (int32)"
  },
  "groupType": "string",
  "majorVersion": "integer (int32)",
  "minorVersion": "integer (int32)",
  "uuid": "string"
}
admin-resource-resource

updateDocumentGroup

POST /v2/admin/resources/document-groups/{uuid}
InternalDocumentGroupUpdateRepresentation

data

uuid: string
in path

uuid

Request Content-Types: application/json
Request Example
{
  "documents": [
    "string"
  ],
  "newMajor": "boolean",
  "type": "string"
}
200 OK
InternalDocumentGroupRepresentation

The updated document group

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "documents": [
    {
      "category": "string",
      "contentType": "string",
      "created": "string",
      "deprecated": "boolean",
      "description": "string",
      "fileName": "string",
      "hash": "string",
      "hashAlg": "string",
      "title": "string",
      "type": "string",
      "typeMeta": "object",
      "uuid": "string"
    }
  ],
  "groupId": {
    "groupId": "string",
    "groupType": "string",
    "major": "integer (int32)",
    "minor": "integer (int32)"
  },
  "groupType": "string",
  "majorVersion": "integer (int32)",
  "minorVersion": "integer (int32)",
  "uuid": "string"
}
admin-resource-resource

listDocuments

GET /v2/admin/resources/documents
200 OK
BwDocument

A list of documents

type
BwDocument
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "category": "string",
    "contentType": "string",
    "created": "string",
    "deprecated": "boolean",
    "description": "string",
    "fileName": "string",
    "hash": "string",
    "hashAlg": "string",
    "title": "string",
    "type": "string",
    "typeMeta": "object",
    "uuid": "string"
  }
]
admin-resource-resource

createDocument

POST /v2/admin/resources/documents
title: string
in query

title

description: string
in query

description

category: string
in query

category

type: string
in query

type

typeMeta: string
in query

typeMeta

document: file
in formData

document

200 OK
BwDocument

The created document

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "category": "string",
  "contentType": "string",
  "created": "string",
  "deprecated": "boolean",
  "description": "string",
  "fileName": "string",
  "hash": "string",
  "hashAlg": "string",
  "title": "string",
  "type": "string",
  "typeMeta": "object",
  "uuid": "string"
}
admin-resource-resource

updateDocumentMeta

PATCH /v2/admin/resources/documents/{documentId}
BwDocumentPatch

patch

documentId: string
in path

documentId

Request Content-Types: application/json
Request Example
{
  "category": {
    "action": "string",
    "value": "string"
  },
  "deprecated": {
    "action": "string",
    "value": "boolean"
  },
  "description": {
    "action": "string",
    "value": "string"
  },
  "title": {
    "action": "string",
    "value": "string"
  },
  "type": {
    "action": "string",
    "value": "string"
  },
  "typeMeta": {
    "action": "string",
    "value": "object"
  }
}
200 OK
BwDocument

The updated document

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "category": "string",
  "contentType": "string",
  "created": "string",
  "deprecated": "boolean",
  "description": "string",
  "fileName": "string",
  "hash": "string",
  "hashAlg": "string",
  "title": "string",
  "type": "string",
  "typeMeta": "object",
  "uuid": "string"
}
admin-resource-resource

getDocument

GET /v2/admin/resources/documents/{uuid}
uuid: string
in path

uuid

200 OK
InputStreamResource

Download the document

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-resource-resource

listFiles

GET /v2/admin/resources/files
type: string
in query

type

status: string
in query

status

pageToken: string
in query

pageToken

200 OK
TokenizedPageBwFile

A page of file meta

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "contentType": "string",
      "created": "string",
      "error": "string",
      "fileContentIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "fileName": "string",
      "fileSourceIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "id": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-resource-resource

Upload a file via cert auth

POST /v2/admin/resources/files
body_hash: string
in query

body_hash

type: string
in query

type

fileName: string
in query

fileName

contentType: string
in query

contentType

sourceIdentifier: string
in query

sourceIdentifier

file: file
in formData

file

200 OK
MultipartResponseContainerBwFile

The uploaded file

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "calculatedHash": "string",
  "providedHash": "string",
  "response": {
    "contentType": "string",
    "created": "string",
    "error": "string",
    "fileContentIdentifier": {
      "identifier": "string",
      "protocol": "string"
    },
    "fileName": "string",
    "fileSourceIdentifier": {
      "identifier": "string",
      "protocol": "string"
    },
    "id": "string",
    "status": "string",
    "type": "string"
  }
}
admin-resource-resource

downloadAssetStorageCheckFile

GET /v2/admin/resources/files/asset-storage-check/{id}
id: string
in path

id

200 OK
InputStreamResource

The downloaded file

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-resource-resource

updateHoldingsFile

PATCH /v2/admin/resources/files/asset-storage-check/{id}
AssetStorageCheckResult

checkResult

id: string
in path

id

Request Content-Types: application/json
Request Example
{
  "date": "string",
  "fileType": "string",
  "result": [
    {
      "assetId": "string",
      "bankAmount": "number (double)",
      "isin": "string",
      "successful": "boolean",
      "systemAmount": "number (double)"
    }
  ],
  "successful": "boolean"
}
200 OK
GenericResponse

Upload processed result for holdings file

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-resource-resource

Upload a file via form, authenticated as an administrator

POST /v2/admin/resources/files/form
type: string
in query

type

fileName: string
in query

fileName

contentType: string
in query

contentType

file: file
in formData

file

200 OK
BwFile

The created file

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "contentType": "string",
  "created": "string",
  "error": "string",
  "fileContentIdentifier": {
    "identifier": "string",
    "protocol": "string"
  },
  "fileName": "string",
  "fileSourceIdentifier": {
    "identifier": "string",
    "protocol": "string"
  },
  "id": "string",
  "status": "string",
  "type": "string"
}
admin-resource-resource

listFilesForTarget

GET /v2/admin/resources/files/target/{targetId}
targetId: string
in path

targetId

pageToken: string
in query

pageToken

200 OK
TokenizedPageBwFile

A page of file meta

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "contentType": "string",
      "created": "string",
      "error": "string",
      "fileContentIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "fileName": "string",
      "fileSourceIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "id": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}
admin-resource-resource

downloadFile

GET /v2/admin/resources/files/{id}
id: string
in path

id

200 OK
InputStreamResource

The downloaded file

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}

healthz-resource

Healthz Resource

healthz-resource

healthz

GET /healthz
200 OK

OK

type
string
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
"string"

admin-auth-resource

Admin Auth Resource

admin-auth-resource

validate

GET /v2/admin/auth/validate
roles: string[]
in query

(no description)

Array values passed as multiple parameters: ?roles=aaa&roles=bbb
authType: string USER, ADMIN, CERT, SERVICE_TO_SERVICE, UNAUTHORIZED
in query

(no description)

clientId: string BW_CLIENT, COLLECTOR_CLIENT, TEST_CLIENT, TEST_CLIENT_NO_AUTO_TRADE, BW_DIY_CLIENT, BW_V2_CLIENT, ALL
in query

(no description)

adminUuid: string
in query

(no description)

200 OK
AdminAuthValidation

List of allowed roles for current admin

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "adminId": "string",
  "authorities": [
    "string"
  ]
}

admin-bank-account-admin-resource

Admin Bank Account Admin Resource

admin-bank-account-admin-resource

listBankAccounts

GET /v2/admin/bank-accounts
agStatus: string NONE, PENDING, EXPORTED, ACTIVE, ERROR, ERROR_BAD_ACC_TYPE, ERROR_INVALID_ACC, ERROR_INVALID_IDENTIFIER, ERROR_INVALID_BANKACCOUNT_NUMBER, PENDING_CANCEL, CANCELED, PENDING_CANCEL_BY_USER, CANCELED_BY_USER, PENDING_CANCEL_BY_ADMIN, CANCELED_BY_ADMIN, CANCELED_BY_EXTERNAL
in query

agStatus

page: integer (int32) 0
in query

page

size: integer (int32) 20
in query

size

200 OK
InternalPageRepresentationBankAccount

Page of bank accounts

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "content": [
    {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}
admin-bank-account-admin-resource

generateApprovalRequests

GET /v2/admin/bank-accounts/auto-giro/approval-requests
200 OK
InputStreamResource

File with approval requests

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}
admin-bank-account-admin-resource

uploadApprovalConfirmation

POST /v2/admin/bank-accounts/auto-giro/approval-requests
AutoGiroFile

file

Request Content-Types: application/json
Request Example
{
  "content": "string",
  "fileType": "string"
}
200 OK
AutogiroApprovalRequestResponseItem

List of response items

type
AutogiroApprovalRequestResponseItem
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "bankAccount": {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    },
    "commentCode": "string",
    "errorMessage": "string",
    "informationCode": "string",
    "status": "string"
  }
]
admin-bank-account-admin-resource

cancelAutogiro

POST /v2/admin/bank-accounts/{bankAccountId}/auto-giro/cancel
bankAccountId: string
in path

bankAccountId

200 OK
BankAccount

The updated bank account

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountNumber": "string",
  "autogiroPayerId": "integer (int64)",
  "autogiroStatus": "string",
  "bankIdentifier": "string",
  "clearingNumber": "string",
  "created": "string",
  "name": "string",
  "primary": "boolean",
  "signature": "string",
  "userUuid": "string",
  "uuid": "string"
}
admin-bank-account-admin-resource

completeCancellation

POST /v2/admin/bank-accounts/{bankAccountId}/auto-giro/cancellation-completed
bankAccountId: string
in path

bankAccountId

200 OK
BankAccount

The updated bank account

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "accountNumber": "string",
  "autogiroPayerId": "integer (int64)",
  "autogiroStatus": "string",
  "bankIdentifier": "string",
  "clearingNumber": "string",
  "created": "string",
  "name": "string",
  "primary": "boolean",
  "signature": "string",
  "userUuid": "string",
  "uuid": "string"
}

admin-bank-id-login-resource

Admin Bank Id Login Resource

admin-bank-id-login-resource

handleBankIdAuthInit

POST /v2/admin/bankid/auth/init
BankIdInitRequest

bankIdInitRequest

Request Content-Types: application/json
Request Example
{
  "allowedUnauthorized": "boolean",
  "personalNumber": "string",
  "requestType": "string"
}
200 OK
BankIdInitResponse

The auth init response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "autoStartToken": "string",
  "bankIdInitStatus": "string",
  "bankIdMessage": "string",
  "pollToken": "string"
}
admin-bank-id-login-resource

handleBankIdAuthPollJson

POST /v2/admin/bankid/auth/poll
BankIdPollRequest

bankIdPollRequest

roles: string[]
in query

(no description)

Array values passed as multiple parameters: ?roles=aaa&roles=bbb
authType: string USER, ADMIN, CERT, SERVICE_TO_SERVICE, UNAUTHORIZED
in query

(no description)

clientId: string BW_CLIENT, COLLECTOR_CLIENT, TEST_CLIENT, TEST_CLIENT_NO_AUTO_TRADE, BW_DIY_CLIENT, BW_V2_CLIENT, ALL
in query

(no description)

Request Content-Types: application/json
Request Example
{
  "pollToken": "string"
}
200 OK
BankIdPollResponse

The poll response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "bankIdMessage": "string",
  "bankIdPollStatus": "string",
  "pollData": {
    "autoStartToken": "string",
    "qrToken": "string"
  },
  "userData": {
    "expires": "integer (int64)",
    "roles": [
      "string"
    ],
    "subject": "string"
  },
  "verifiedCustomer": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}
admin-bank-id-login-resource

handleBankIdSignInit

POST /v2/admin/bankid/sign/init
BankIdInitRequest

bankIdInitRequest

Request Content-Types: application/json
Request Example
{
  "allowedUnauthorized": "boolean",
  "personalNumber": "string",
  "requestType": "string"
}
200 OK
BankIdInitResponse

The sign init response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "autoStartToken": "string",
  "bankIdInitStatus": "string",
  "bankIdMessage": "string",
  "pollToken": "string"
}
admin-bank-id-login-resource

handleBankIdSignPoll

POST /v2/admin/bankid/sign/poll
BankIdPollRequest

bankIdPollRequest

roles: string[]
in query

(no description)

Array values passed as multiple parameters: ?roles=aaa&roles=bbb
authType: string USER, ADMIN, CERT, SERVICE_TO_SERVICE, UNAUTHORIZED
in query

(no description)

clientId: string BW_CLIENT, COLLECTOR_CLIENT, TEST_CLIENT, TEST_CLIENT_NO_AUTO_TRADE, BW_DIY_CLIENT, BW_V2_CLIENT, ALL
in query

(no description)

Request Content-Types: application/json
Request Example
{
  "pollToken": "string"
}
200 OK
BankIdPollResponse

The poll response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "bankIdMessage": "string",
  "bankIdPollStatus": "string",
  "pollData": {
    "autoStartToken": "string",
    "qrToken": "string"
  },
  "userData": {
    "expires": "integer (int64)",
    "roles": [
      "string"
    ],
    "subject": "string"
  },
  "verifiedCustomer": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}
admin-bank-id-login-resource

handleBankIdUserViewInit

POST /v2/admin/bankid/user-view/init
BankIdInitVerifyCustomerRequest

bankIdInitRequest

Request Content-Types: application/json
Request Example
{
  "allowedUnauthorized": "boolean",
  "clientId": "string",
  "initiator": "string",
  "personalNumber": "string",
  "requestType": "string",
  "userId": "string"
}
200 OK
BankIdInitResponse

The user view init response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "autoStartToken": "string",
  "bankIdInitStatus": "string",
  "bankIdMessage": "string",
  "pollToken": "string"
}
admin-bank-id-login-resource

handleBankIdVerifyInit

POST /v2/admin/bankid/verify/init
BankIdInitVerifyCustomerRequest

bankIdInitRequest

Request Content-Types: application/json
Request Example
{
  "allowedUnauthorized": "boolean",
  "clientId": "string",
  "initiator": "string",
  "personalNumber": "string",
  "requestType": "string",
  "userId": "string"
}
200 OK
BankIdInitResponse

The verify init response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "autoStartToken": "string",
  "bankIdInitStatus": "string",
  "bankIdMessage": "string",
  "pollToken": "string"
}
admin-bank-id-login-resource

handleBankIdVerifyPollJson

POST /v2/admin/bankid/verify/poll
BankIdPollRequest

bankIdPollRequest

roles: string[]
in query

(no description)

Array values passed as multiple parameters: ?roles=aaa&roles=bbb
authType: string USER, ADMIN, CERT, SERVICE_TO_SERVICE, UNAUTHORIZED
in query

(no description)

clientId: string BW_CLIENT, COLLECTOR_CLIENT, TEST_CLIENT, TEST_CLIENT_NO_AUTO_TRADE, BW_DIY_CLIENT, BW_V2_CLIENT, ALL
in query

(no description)

Request Content-Types: application/json
Request Example
{
  "pollToken": "string"
}
200 OK
BankIdPollResponse

The poll response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "bankIdMessage": "string",
  "bankIdPollStatus": "string",
  "pollData": {
    "autoStartToken": "string",
    "qrToken": "string"
  },
  "userData": {
    "expires": "integer (int64)",
    "roles": [
      "string"
    ],
    "subject": "string"
  },
  "verifiedCustomer": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}

admin-investment-strategy-resource

Admin Investment Strategy Resource

admin-investment-strategy-resource

getDefaultFees

GET /v2/admin/investment-strategy/default-fees
clientId: string
in query

clientId

200 OK
DefaultFee

List of all default fees

type
DefaultFee
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "fee": {
      "fixedTradeFee": {
        "exchangeFee": "number (double)",
        "tradeFee": "number (double)"
      },
      "managementFee": "number (double)",
      "noValueBasedDiscount": "boolean",
      "safekeepingFee": "number (double)",
      "tradeFeesNotIncluded": "boolean",
      "valueBasedDiscount": "number (double)",
      "vat": "number (double)"
    },
    "investmentStrategyType": "string"
  }
]
admin-investment-strategy-resource

getDefaultFee

GET /v2/admin/investment-strategy/default-fees/{investmentStrategy}
investmentStrategy: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
in path

investmentStrategy

200 OK
DefaultFee

Default fee for investment strategy

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "investmentStrategyType": "string"
}

admin-risk-factor-admin-resource

Admin Risk Factor Admin Resource

admin-risk-factor-admin-resource

getRiskFactors

GET /v2/admin/risk-factors
200 OK
RiskFactor

All risk factors

type
RiskFactor
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "currency": "string",
    "distributing": "boolean",
    "id": "string",
    "name": "string",
    "trackingETF": "string",
    "trackingExchange": "string"
  }
]
admin-risk-factor-admin-resource

createRiskFactors

POST /v2/admin/risk-factors/csv/create
CSVDataContainer

data

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
RiskFactor

The updated risk factors

type
RiskFactor
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "currency": "string",
    "distributing": "boolean",
    "id": "string",
    "name": "string",
    "trackingETF": "string",
    "trackingExchange": "string"
  }
]
admin-risk-factor-admin-resource

bulkUpdateRiskFactors

POST /v2/admin/risk-factors/csv/update
CSVDataContainer

data

Request Content-Types: application/json
Request Example
{
  "data": "string"
}
200 OK
GenericResponse

A response

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "value": "string"
}
admin-risk-factor-admin-resource

getRiskFactor

GET /v2/admin/risk-factors/{riskFactorId}
riskFactorId: string
in path

riskFactorId

200 OK
RiskFactor

The referenced risk factor

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "currency": "string",
  "distributing": "boolean",
  "id": "string",
  "name": "string",
  "trackingETF": "string",
  "trackingExchange": "string"
}
admin-risk-factor-admin-resource

getRiskFactorHistory

GET /v2/admin/risk-factors/{riskFactorId}/history
riskFactorId: string
in path

riskFactorId

200 OK
TimeSeriesEntry

Historical risk factor values

type
TimeSeriesEntry
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
[
  {
    "dateTime": "string",
    "value": "number (double)"
  }
]

Schema Definitions

AccruedFee: object

adjustedFee: Decimal
endDate: DateRepresentation
fee: Decimal
startDate: DateRepresentation
transferredFee: Decimal
Example
{
  "adjustedFee": "number (double)",
  "endDate": "string",
  "fee": "number (double)",
  "startDate": "string",
  "transferredFee": "number (double)"
}

ActionCode: object

activatorAction: string no_action, void_action, period_discount, period_fixed, value_discount
activatorActionProps: ActionProps
created: DateTimeRepresentation
description: string
expiration: DateTimeRepresentation
id: string
issuer: string
issuerAction: string no_action, void_action, period_discount, period_fixed, value_discount
issuerActionCondition: string unconditional, value_threshold
issuerActionConditionProps: ActionConditionProps
issuerActionProps: ActionProps
name: string
type: string referral, affiliate, discount, one_time_discount
Example
{
  "activatorAction": "string",
  "activatorActionProps": {
    "initialValue": "number (double)"
  },
  "created": "string",
  "description": "string",
  "expiration": "string",
  "id": "string",
  "issuer": "string",
  "issuerAction": "string",
  "issuerActionCondition": "string",
  "issuerActionConditionProps": "object",
  "issuerActionProps": {
    "initialValue": "number (double)"
  },
  "name": "string",
  "type": "string"
}

ActionCodeActivation: object

activationDate: DateTimeRepresentation
activator: string
activatorValue: Decimal
code: ActionCode
id: string
issuerActivationDate: DateTimeRepresentation
issuerValue: Decimal
Example
{
  "activationDate": "string",
  "activator": "string",
  "activatorValue": "number (double)",
  "code": {
    "activatorAction": "string",
    "activatorActionProps": {
      "initialValue": "number (double)"
    },
    "created": "string",
    "description": "string",
    "expiration": "string",
    "id": "string",
    "issuer": "string",
    "issuerAction": "string",
    "issuerActionCondition": "string",
    "issuerActionConditionProps": "object",
    "issuerActionProps": {
      "initialValue": "number (double)"
    },
    "name": "string",
    "type": "string"
  },
  "id": "string",
  "issuerActivationDate": "string",
  "issuerValue": "number (double)"
}

ActionCodeUserActivation: object

action: string no_action, void_action, period_discount, period_fixed, value_discount
actionProps: ActionProps
activated: DateTimeRepresentation
codeId: string
description: string
id: string
name: string
role: string activator, issuer
type: string referral, affiliate, discount, one_time_discount
value: Decimal
Example
{
  "action": "string",
  "actionProps": {
    "initialValue": "number (double)"
  },
  "activated": "string",
  "codeId": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "role": "string",
  "type": "string",
  "value": "number (double)"
}

ActionCodeWithUrl: object

activationUrl: string
activatorAction: string no_action, void_action, period_discount, period_fixed, value_discount
activatorActionProps: ActionProps
created: DateTimeRepresentation
description: string
expiration: DateTimeRepresentation
id: string
issuer: string
issuerAction: string no_action, void_action, period_discount, period_fixed, value_discount
issuerActionCondition: string unconditional, value_threshold
issuerActionConditionProps: ActionConditionProps
issuerActionProps: ActionProps
name: string
type: string referral, affiliate, discount, one_time_discount
Example
{
  "activationUrl": "string",
  "activatorAction": "string",
  "activatorActionProps": {
    "initialValue": "number (double)"
  },
  "created": "string",
  "description": "string",
  "expiration": "string",
  "id": "string",
  "issuer": "string",
  "issuerAction": "string",
  "issuerActionCondition": "string",
  "issuerActionConditionProps": "object",
  "issuerActionProps": {
    "initialValue": "number (double)"
  },
  "name": "string",
  "type": "string"
}

ActionConditionProps: object

Example
"object"

ActionProps: object

initialValue: Decimal
Example
{
  "initialValue": "number (double)"
}

Admin: object

authorities: string[]
string
disabled: boolean
email: string
imageUrl: string
name: string
personalNumber: SwedishPersonalNumber
phone: string
uuid: string
Example
{
  "authorities": [
    "string"
  ],
  "disabled": "boolean",
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "personalNumber": "string",
  "phone": "string",
  "uuid": "string"
}

AdminAuthValidation: object

adminId: string
authorities: string[]
string
Example
{
  "adminId": "string",
  "authorities": [
    "string"
  ]
}

AdminCustomerPatch: object

authRoles: FieldPatch«List«string»»
features: FieldPatch«List«string»»
premiumContact: FieldPatch«string»
premiumLevel: FieldPatch«string»
riskCategory: FieldPatch«string»
Example
{
  "authRoles": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "features": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "premiumContact": {
    "action": "string",
    "value": "string"
  },
  "premiumLevel": {
    "action": "string",
    "value": "string"
  },
  "riskCategory": {
    "action": "string",
    "value": "string"
  }
}

AdminLogEntry: object

adminId: string
adminLogEntryType: string ADMIN_LOGIN, ADMIN_VERIFY_USER, ADMIN_CREATED, ADMIN_UPDATED, TRANSACTIONS_EXPORTED, TRANSACTION_EXPORTED, TRANSACTION_COMPLETED, TRADE_GENERATED, TRADE_COMPLETED, TRADE_CANCELED, TEMPLATE_PORTFOLIO_CREATE, TEMPLATE_PORTFOLIO_UPDATE, TEMPLATE_PORTFOLIO_DIST_REFRESH, PORTFOLIO_ERROR_CLEARED, PORTFOLIO_FEE_ADJUSTMENT_ADDED, ASSET_STORAGE_DEPOSIT, ASSET_STORAGE_DIFF_CHECKPOINT, BALANCE_CHECKPOINT, MARKET_TRADE_ORDER_UPDATED, MARKET_TRADE_ORDER_COMPLETED, MARKET_TRADE_ORDER_SEMICOMPLETED, MARKET_TRADE_ORDER_CANCELED, MARKET_TRADE_ORDER_VOVERRIDE, USER_KNOWLEDGE_UPDATED, USER_NOTE, MANUAL_BALANCE_CHECK, CASH_BALANCE_CHECK, HOLDINGS_CHECK, TOTAL_BALANCE, SUSPICIOUS_TRANSACTION_UPDATED, ASSET_UPDATE, ASSET_TRANSACTION, NOTIFICATION_CREATED, NOTIFICATION_UPDATED, USER_MIGRATED
payload: AdminLogEntryPayload
targetId: string
timestamp: integer (int64)
type: string
uuid: string
Example
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}

AdminLogEntryPayload: object

Example
"object"

AdminLogEntry«object»: object

adminId: string
adminLogEntryType: string ADMIN_LOGIN, ADMIN_VERIFY_USER, ADMIN_CREATED, ADMIN_UPDATED, TRANSACTIONS_EXPORTED, TRANSACTION_EXPORTED, TRANSACTION_COMPLETED, TRADE_GENERATED, TRADE_COMPLETED, TRADE_CANCELED, TEMPLATE_PORTFOLIO_CREATE, TEMPLATE_PORTFOLIO_UPDATE, TEMPLATE_PORTFOLIO_DIST_REFRESH, PORTFOLIO_ERROR_CLEARED, PORTFOLIO_FEE_ADJUSTMENT_ADDED, ASSET_STORAGE_DEPOSIT, ASSET_STORAGE_DIFF_CHECKPOINT, BALANCE_CHECKPOINT, MARKET_TRADE_ORDER_UPDATED, MARKET_TRADE_ORDER_COMPLETED, MARKET_TRADE_ORDER_SEMICOMPLETED, MARKET_TRADE_ORDER_CANCELED, MARKET_TRADE_ORDER_VOVERRIDE, USER_KNOWLEDGE_UPDATED, USER_NOTE, MANUAL_BALANCE_CHECK, CASH_BALANCE_CHECK, HOLDINGS_CHECK, TOTAL_BALANCE, SUSPICIOUS_TRANSACTION_UPDATED, ASSET_UPDATE, ASSET_TRANSACTION, NOTIFICATION_CREATED, NOTIFICATION_UPDATED, USER_MIGRATED
payload: object
targetId: string
timestamp: integer (int64)
type: string
uuid: string
Example
{
  "adminId": "string",
  "adminLogEntryType": "string",
  "payload": "object",
  "targetId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}

AdminPatch: object

authorities: FieldPatch«List«string»»
disabled: FieldPatch«boolean»
email: FieldPatch«string»
imageUrl: FieldPatch«string»
name: FieldPatch«string»
phone: FieldPatch«string»
Example
{
  "authorities": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "disabled": {
    "action": "string",
    "value": "boolean"
  },
  "email": {
    "action": "string",
    "value": "string"
  },
  "imageUrl": {
    "action": "string",
    "value": "string"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "phone": {
    "action": "string",
    "value": "string"
  }
}

Asset: object

activeManagement: boolean
added: DateTimeRepresentation
assetClass: string EQUITY, FIXED_INCOME, ALTERNATIVE, COMMODITIES, CASH
aum: Decimal
aumCurrency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
aumDate: DateRepresentation
baseValue: AssetBaseValue
benchmarkName: string
categorySwe: string
ceo: string
commentsSwe: string
country: string
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
currencyAllocation: object
currencyAllocationDate: DateRepresentation
currencyExchangeFeeDisabled: boolean
currencyHedged: boolean
dataSourceExchangeCode: string
descriptionSwe: string
dividendCurrency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
dividendFrequency: string NONE, QUARTER, SEMI_ANL, ANNUAL, IRREGULAR, MONTHLY
dividendYield: Decimal
exchangeCode: string XFU, XET, LSF, LSTU, AETF, SWF, SSE, ENPF
geoAllocation: object
geoAllocationDate: DateRepresentation
geography: string ASIA_PACIFIC, EUROPE, LATIN_AMERICA, MIDDLE_EAST_AND_AFRICA, NORTH_AMERICA, GLOBAL
holdingsAllocation: object
holdingsAllocationDate: DateRepresentation
id: string
inceptionDate: DateRepresentation
index: integer (int32)
isActiveModel: boolean
isActivePlatform: boolean
isCollectingData: boolean
isTradeStopped: boolean
isin: string
issuingCompany: string
kiidUrl: string
market: string DEVELOPED, EMERGING, OTHER
metricBeta: Decimal
metricPe: Decimal
metricPs: Decimal
msciEsgDataDate: DateRepresentation
msciEsgDataPresent: boolean
msciEsgQualityScore: Decimal
msciEsgQualityScorePctlGlobal: Decimal
msciEsgQualityScorePctlPeer: Decimal
msciEsgRating: string
msciSustainableImpactPct: Decimal
msciWaCO2i: Decimal
name: string
notes: string
numEmployees: integer (int32)
numberOfHoldings: integer (int32)
numberOfHoldingsDate: DateRepresentation
orderRoute: string SMART, CARE
replicationStrategy: string PHYSICAL, SYNTHETIC
riskFactor: string
riskLevel: integer (int32)
sectors: string[]
string energy, materials, industrials, utilities, healthcare, financials, consumer discretionary, consumer staples, information technology, communication services, real estate
sharesTotal: integer (int32)
shortName: string
simpleId: integer (int64)
sri: boolean
strategyDescriptionSwe: string
tags: string[]
string
ter: Decimal
ticker: string
tradeFeeDisabled: boolean
type: string ETF, ETF_TEMP, CASH, STOCK, FUND
ucits: boolean
url: string
value: AssetValue
Example
{
  "activeManagement": "boolean",
  "added": "string",
  "assetClass": "string",
  "aum": "number (double)",
  "aumCurrency": "string",
  "aumDate": "string",
  "baseValue": {
    "lastClosing": "number (double)",
    "lastClosingDate": "string"
  },
  "benchmarkName": "string",
  "categorySwe": "string",
  "ceo": "string",
  "commentsSwe": "string",
  "country": "string",
  "currency": "string",
  "currencyAllocation": "object",
  "currencyAllocationDate": "string",
  "currencyExchangeFeeDisabled": "boolean",
  "currencyHedged": "boolean",
  "dataSourceExchangeCode": "string",
  "descriptionSwe": "string",
  "dividendCurrency": "string",
  "dividendFrequency": "string",
  "dividendYield": "number (double)",
  "exchangeCode": "string",
  "geoAllocation": "object",
  "geoAllocationDate": "string",
  "geography": "string",
  "holdingsAllocation": "object",
  "holdingsAllocationDate": "string",
  "id": "string",
  "inceptionDate": "string",
  "index": "integer (int32)",
  "isActiveModel": "boolean",
  "isActivePlatform": "boolean",
  "isCollectingData": "boolean",
  "isTradeStopped": "boolean",
  "isin": "string",
  "issuingCompany": "string",
  "kiidUrl": "string",
  "market": "string",
  "metricBeta": "number (double)",
  "metricPe": "number (double)",
  "metricPs": "number (double)",
  "msciEsgDataDate": "string",
  "msciEsgDataPresent": "boolean",
  "msciEsgQualityScore": "number (double)",
  "msciEsgQualityScorePctlGlobal": "number (double)",
  "msciEsgQualityScorePctlPeer": "number (double)",
  "msciEsgRating": "string",
  "msciSustainableImpactPct": "number (double)",
  "msciWaCO2i": "number (double)",
  "name": "string",
  "notes": "string",
  "numEmployees": "integer (int32)",
  "numberOfHoldings": "integer (int32)",
  "numberOfHoldingsDate": "string",
  "orderRoute": "string",
  "replicationStrategy": "string",
  "riskFactor": "string",
  "riskLevel": "integer (int32)",
  "sectors": [
    "string"
  ],
  "sharesTotal": "integer (int32)",
  "shortName": "string",
  "simpleId": "integer (int64)",
  "sri": "boolean",
  "strategyDescriptionSwe": "string",
  "tags": [
    "string"
  ],
  "ter": "number (double)",
  "ticker": "string",
  "tradeFeeDisabled": "boolean",
  "type": "string",
  "ucits": "boolean",
  "url": "string",
  "value": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "fiveYears": "number (double)",
    "last": "number (double)",
    "lastClosing": "number (double)",
    "lastClosingDate": "string",
    "lastPeriodUpdate": "string",
    "lastValueUpdated": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sell": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}

AssetAmount: object

assetId: string
minAmount: Decimal
Example
{
  "assetId": "string",
  "minAmount": "number (double)"
}

AssetBaseValue: object

lastClosing: Decimal
lastClosingDate: DateRepresentation
Example
{
  "lastClosing": "number (double)",
  "lastClosingDate": "string"
}

AssetCreateData: object

activeManagement: FieldPatch«boolean»
assetClass: FieldPatch«string»
aum: FieldPatch«ValueAndDate«Decimal»»
aumCurrency: FieldPatch«string»
benchmarkName: FieldPatch«string»
categorySwe: FieldPatch«string»
ceo: FieldPatch«string»
commentsSwe: FieldPatch«string»
country: FieldPatch«string»
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
currencyAllocation: FieldPatch«ValueAndDate«Map«string,Decimal»»»
currencyExchangeFeeDisabled: FieldPatch«boolean»
currencyHedged: FieldPatch«boolean»
dataSourceExchangeCode: FieldPatch«string»
descStrategySwe: FieldPatch«string»
descSwe: FieldPatch«string»
dividendCurrency: FieldPatch«string»
dividendFrequency: FieldPatch«string»
dividendYield: FieldPatch«Decimal»
exchangeCode: string XFU, XET, LSF, LSTU, AETF, SWF, SSE, ENPF
geoAllocation: FieldPatch«ValueAndDate«Map«string,Decimal»»»
geography: FieldPatch«string»
holdingsAllocation: FieldPatch«ValueAndDate«Map«string,Decimal»»»
inceptionDate: FieldPatch«DateRepresentation»
index: FieldPatch«int»
isActiveModel: FieldPatch«boolean»
isActivePlatform: FieldPatch«boolean»
isCollectingData: FieldPatch«boolean»
isTradeStopped: FieldPatch«boolean»
isin: string
issuingCompany: FieldPatch«string»
kiidUrl: FieldPatch«string»
market: FieldPatch«string»
metricBeta: FieldPatch«Decimal»
metricPe: FieldPatch«Decimal»
metricPs: FieldPatch«Decimal»
name: FieldPatch«string»
notes: FieldPatch«string»
numEmployees: FieldPatch«int»
numberOfHoldings: FieldPatch«ValueAndDate«int»»
orderRoute: FieldPatch«string»
replicationStrategy: FieldPatch«string»
riskFactor: FieldPatch«string»
riskLevel: FieldPatch«int»
sectors: FieldPatch«List«string»»
sharesTotal: FieldPatch«int»
shortName: FieldPatch«string»
sri: FieldPatch«boolean»
ter: FieldPatch«Decimal»
ticker: string
tradeFeeDisabled: FieldPatch«boolean»
type: string ETF, ETF_TEMP, CASH, STOCK, FUND
ucits: FieldPatch«boolean»
url: FieldPatch«string»
Example
{
  "activeManagement": {
    "action": "string",
    "value": "boolean"
  },
  "assetClass": {
    "action": "string",
    "value": "string"
  },
  "aum": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "number (double)"
    }
  },
  "aumCurrency": {
    "action": "string",
    "value": "string"
  },
  "benchmarkName": {
    "action": "string",
    "value": "string"
  },
  "categorySwe": {
    "action": "string",
    "value": "string"
  },
  "ceo": {
    "action": "string",
    "value": "string"
  },
  "commentsSwe": {
    "action": "string",
    "value": "string"
  },
  "country": {
    "action": "string",
    "value": "string"
  },
  "currency": "string",
  "currencyAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "currencyExchangeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "currencyHedged": {
    "action": "string",
    "value": "boolean"
  },
  "dataSourceExchangeCode": {
    "action": "string",
    "value": "string"
  },
  "descStrategySwe": {
    "action": "string",
    "value": "string"
  },
  "descSwe": {
    "action": "string",
    "value": "string"
  },
  "dividendCurrency": {
    "action": "string",
    "value": "string"
  },
  "dividendFrequency": {
    "action": "string",
    "value": "string"
  },
  "dividendYield": {
    "action": "string",
    "value": "number (double)"
  },
  "exchangeCode": "string",
  "geoAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "geography": {
    "action": "string",
    "value": "string"
  },
  "holdingsAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "inceptionDate": {
    "action": "string",
    "value": "string"
  },
  "index": {
    "action": "string",
    "value": "integer (int32)"
  },
  "isActiveModel": {
    "action": "string",
    "value": "boolean"
  },
  "isActivePlatform": {
    "action": "string",
    "value": "boolean"
  },
  "isCollectingData": {
    "action": "string",
    "value": "boolean"
  },
  "isTradeStopped": {
    "action": "string",
    "value": "boolean"
  },
  "isin": "string",
  "issuingCompany": {
    "action": "string",
    "value": "string"
  },
  "kiidUrl": {
    "action": "string",
    "value": "string"
  },
  "market": {
    "action": "string",
    "value": "string"
  },
  "metricBeta": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPe": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPs": {
    "action": "string",
    "value": "number (double)"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "notes": {
    "action": "string",
    "value": "string"
  },
  "numEmployees": {
    "action": "string",
    "value": "integer (int32)"
  },
  "numberOfHoldings": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "integer (int32)"
    }
  },
  "orderRoute": {
    "action": "string",
    "value": "string"
  },
  "replicationStrategy": {
    "action": "string",
    "value": "string"
  },
  "riskFactor": {
    "action": "string",
    "value": "string"
  },
  "riskLevel": {
    "action": "string",
    "value": "integer (int32)"
  },
  "sectors": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "sharesTotal": {
    "action": "string",
    "value": "integer (int32)"
  },
  "shortName": {
    "action": "string",
    "value": "string"
  },
  "sri": {
    "action": "string",
    "value": "boolean"
  },
  "ter": {
    "action": "string",
    "value": "number (double)"
  },
  "ticker": "string",
  "tradeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "type": "string",
  "ucits": {
    "action": "string",
    "value": "boolean"
  },
  "url": {
    "action": "string",
    "value": "string"
  }
}

AssetDataUploadRequest: object

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
dataSourceExchangeCode: string
exchangeCode: string
ticker: string
Example
{
  "currency": "string",
  "dataSourceExchangeCode": "string",
  "exchangeCode": "string",
  "ticker": "string"
}

AssetESGDataPatch: object

msciEsgDataDate: FieldPatch«DateRepresentation»
msciEsgDataPresent: FieldPatch«boolean»
msciEsgQualityScore: FieldPatch«Decimal»
msciEsgQualityScorePctlGlobal: FieldPatch«Decimal»
msciEsgQualityScorePctlPeer: FieldPatch«Decimal»
msciEsgRating: FieldPatch«string»
msciSustainableImpactPct: FieldPatch«Decimal»
msciWaCO2i: FieldPatch«Decimal»
Example
{
  "msciEsgDataDate": {
    "action": "string",
    "value": "string"
  },
  "msciEsgDataPresent": {
    "action": "string",
    "value": "boolean"
  },
  "msciEsgQualityScore": {
    "action": "string",
    "value": "number (double)"
  },
  "msciEsgQualityScorePctlGlobal": {
    "action": "string",
    "value": "number (double)"
  },
  "msciEsgQualityScorePctlPeer": {
    "action": "string",
    "value": "number (double)"
  },
  "msciEsgRating": {
    "action": "string",
    "value": "string"
  },
  "msciSustainableImpactPct": {
    "action": "string",
    "value": "number (double)"
  },
  "msciWaCO2i": {
    "action": "string",
    "value": "number (double)"
  }
}

AssetFilter: object

active: boolean
activeModel: boolean
activePlatform: boolean
assetClass: string[]
string EQUITY, FIXED_INCOME, ALTERNATIVE, COMMODITIES, CASH
assetTypes: string[]
string ETF, ETF_TEMP, CASH, STOCK, FUND
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
country: string[]
string
discountConfig: string NO_DISCOUNT, TRADE_DISCOUNT, EXCHANGE_DISCOUNT, FULL_DISCOUNT
geography: string[]
string ASIA_PACIFIC, EUROPE, LATIN_AMERICA, MIDDLE_EAST_AND_AFRICA, NORTH_AMERICA, GLOBAL
hasDivdend: boolean
invertOrder: boolean
investmentStrategyType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
isins: string[]
string
market: string[]
string DEVELOPED, EMERGING, OTHER
order: string INDEX, CREATED, NAME, SHORT_NAME, CURRENCY, TER, ESG_RATING, RISK_LEVEL, RETURN_ONE_MONTH, RETURN_THREE_MONTHS, RETURN_SIX_MONTHS, RETURN_THIS_YEAR, RETURN_ONE_YEAR, RETURN_THREE_YEARS, RETURN_FIVE_YEARS
sector: string[]
string energy, materials, industrials, utilities, healthcare, financials, consumer discretionary, consumer staples, information technology, communication services, real estate
sri: boolean[]
boolean
tags: string[]
string
Example
{
  "active": "boolean",
  "activeModel": "boolean",
  "activePlatform": "boolean",
  "assetClass": [
    "string"
  ],
  "assetTypes": [
    "string"
  ],
  "clientId": "string",
  "country": [
    "string"
  ],
  "discountConfig": "string",
  "geography": [
    "string"
  ],
  "hasDivdend": "boolean",
  "invertOrder": "boolean",
  "investmentStrategyType": "string",
  "isins": [
    "string"
  ],
  "market": [
    "string"
  ],
  "order": "string",
  "sector": [
    "string"
  ],
  "sri": [
    "boolean"
  ],
  "tags": [
    "string"
  ]
}

AssetPatch: object

activeManagement: FieldPatch«boolean»
assetClass: FieldPatch«string»
aum: FieldPatch«ValueAndDate«Decimal»»
aumCurrency: FieldPatch«string»
benchmarkName: FieldPatch«string»
categorySwe: FieldPatch«string»
ceo: FieldPatch«string»
commentsSwe: FieldPatch«string»
country: FieldPatch«string»
currencyAllocation: FieldPatch«ValueAndDate«Map«string,Decimal»»»
currencyExchangeFeeDisabled: FieldPatch«boolean»
currencyHedged: FieldPatch«boolean»
dataSourceExchangeCode: FieldPatch«string»
descStrategySwe: FieldPatch«string»
descSwe: FieldPatch«string»
dividendCurrency: FieldPatch«string»
dividendFrequency: FieldPatch«string»
dividendYield: FieldPatch«Decimal»
geoAllocation: FieldPatch«ValueAndDate«Map«string,Decimal»»»
geography: FieldPatch«string»
holdingsAllocation: FieldPatch«ValueAndDate«Map«string,Decimal»»»
inceptionDate: FieldPatch«DateRepresentation»
index: FieldPatch«int»
isActiveModel: FieldPatch«boolean»
isActivePlatform: FieldPatch«boolean»
isCollectingData: FieldPatch«boolean»
isTradeStopped: FieldPatch«boolean»
issuingCompany: FieldPatch«string»
kiidUrl: FieldPatch«string»
market: FieldPatch«string»
metricBeta: FieldPatch«Decimal»
metricPe: FieldPatch«Decimal»
metricPs: FieldPatch«Decimal»
name: FieldPatch«string»
notes: FieldPatch«string»
numEmployees: FieldPatch«int»
numberOfHoldings: FieldPatch«ValueAndDate«int»»
orderRoute: FieldPatch«string»
replicationStrategy: FieldPatch«string»
riskFactor: FieldPatch«string»
riskLevel: FieldPatch«int»
sectors: FieldPatch«List«string»»
sharesTotal: FieldPatch«int»
shortName: FieldPatch«string»
sri: FieldPatch«boolean»
ter: FieldPatch«Decimal»
tradeFeeDisabled: FieldPatch«boolean»
ucits: FieldPatch«boolean»
url: FieldPatch«string»
Example
{
  "activeManagement": {
    "action": "string",
    "value": "boolean"
  },
  "assetClass": {
    "action": "string",
    "value": "string"
  },
  "aum": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "number (double)"
    }
  },
  "aumCurrency": {
    "action": "string",
    "value": "string"
  },
  "benchmarkName": {
    "action": "string",
    "value": "string"
  },
  "categorySwe": {
    "action": "string",
    "value": "string"
  },
  "ceo": {
    "action": "string",
    "value": "string"
  },
  "commentsSwe": {
    "action": "string",
    "value": "string"
  },
  "country": {
    "action": "string",
    "value": "string"
  },
  "currencyAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "currencyExchangeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "currencyHedged": {
    "action": "string",
    "value": "boolean"
  },
  "dataSourceExchangeCode": {
    "action": "string",
    "value": "string"
  },
  "descStrategySwe": {
    "action": "string",
    "value": "string"
  },
  "descSwe": {
    "action": "string",
    "value": "string"
  },
  "dividendCurrency": {
    "action": "string",
    "value": "string"
  },
  "dividendFrequency": {
    "action": "string",
    "value": "string"
  },
  "dividendYield": {
    "action": "string",
    "value": "number (double)"
  },
  "geoAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "geography": {
    "action": "string",
    "value": "string"
  },
  "holdingsAllocation": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "object"
    }
  },
  "inceptionDate": {
    "action": "string",
    "value": "string"
  },
  "index": {
    "action": "string",
    "value": "integer (int32)"
  },
  "isActiveModel": {
    "action": "string",
    "value": "boolean"
  },
  "isActivePlatform": {
    "action": "string",
    "value": "boolean"
  },
  "isCollectingData": {
    "action": "string",
    "value": "boolean"
  },
  "isTradeStopped": {
    "action": "string",
    "value": "boolean"
  },
  "issuingCompany": {
    "action": "string",
    "value": "string"
  },
  "kiidUrl": {
    "action": "string",
    "value": "string"
  },
  "market": {
    "action": "string",
    "value": "string"
  },
  "metricBeta": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPe": {
    "action": "string",
    "value": "number (double)"
  },
  "metricPs": {
    "action": "string",
    "value": "number (double)"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "notes": {
    "action": "string",
    "value": "string"
  },
  "numEmployees": {
    "action": "string",
    "value": "integer (int32)"
  },
  "numberOfHoldings": {
    "action": "string",
    "value": {
      "date": "string",
      "valid": "boolean",
      "value": "integer (int32)"
    }
  },
  "orderRoute": {
    "action": "string",
    "value": "string"
  },
  "replicationStrategy": {
    "action": "string",
    "value": "string"
  },
  "riskFactor": {
    "action": "string",
    "value": "string"
  },
  "riskLevel": {
    "action": "string",
    "value": "integer (int32)"
  },
  "sectors": {
    "action": "string",
    "value": [
      "string"
    ]
  },
  "sharesTotal": {
    "action": "string",
    "value": "integer (int32)"
  },
  "shortName": {
    "action": "string",
    "value": "string"
  },
  "sri": {
    "action": "string",
    "value": "boolean"
  },
  "ter": {
    "action": "string",
    "value": "number (double)"
  },
  "tradeFeeDisabled": {
    "action": "string",
    "value": "boolean"
  },
  "ucits": {
    "action": "string",
    "value": "boolean"
  },
  "url": {
    "action": "string",
    "value": "string"
  }
}

AssetPeriodValueUpdate: object

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
fiveYears: Decimal
oneMonth: Decimal
oneYear: Decimal
sixMonths: Decimal
thisYear: Decimal
threeMonths: Decimal
threeYears: Decimal
ticker: string
updated: DateRepresentation
Example
{
  "currency": "string",
  "fiveYears": "number (double)",
  "oneMonth": "number (double)",
  "oneYear": "number (double)",
  "sixMonths": "number (double)",
  "thisYear": "number (double)",
  "threeMonths": "number (double)",
  "threeYears": "number (double)",
  "ticker": "string",
  "updated": "string"
}

AssetStorageCheckResult: object

date: DateRepresentation
fileType: string trade_report, trade_settlement, cash_transactions, holdings, withdrawal_request, approval_request, bg_max, payment_specification, payment_modification, iso22002
result: ResultItem
ResultItem
successful: boolean
Example
{
  "date": "string",
  "fileType": "string",
  "result": [
    {
      "assetId": "string",
      "bankAmount": "number (double)",
      "isin": "string",
      "successful": "boolean",
      "systemAmount": "number (double)"
    }
  ],
  "successful": "boolean"
}

AssetStorageCheckResultItem: object

fileId: string
logItemId: string
result: AssetStorageCheckResult
resultType: string HOLDINGS_CHECK, CASH_BALANCE_CHECK
Example
{
  "fileId": "string",
  "logItemId": "string",
  "result": {
    "date": "string",
    "fileType": "string",
    "result": [
      {
        "assetId": "string",
        "bankAmount": "number (double)",
        "isin": "string",
        "successful": "boolean",
        "systemAmount": "number (double)"
      }
    ],
    "successful": "boolean"
  },
  "resultType": "string"
}

AssetStorageDepositRepresentation: object

absChangeOnly: boolean
amount: Decimal
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
message: string
Example
{
  "absChangeOnly": "boolean",
  "amount": "number (double)",
  "currency": "string",
  "message": "string"
}

AssetTag: object

assetId: string
id: string
source: string props, manual, sector
tagName: string
Example
{
  "assetId": "string",
  "id": "string",
  "source": "string",
  "tagName": "string"
}

AssetTagCreateData: object

tagName: string
Example
{
  "tagName": "string"
}

AssetUploadResultRepresentations: object

assetId: string
assetName: string
error: string
Example
{
  "assetId": "string",
  "assetName": "string",
  "error": "string"
}

AssetValue: object

buy: Decimal
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
currencyExchangeRate: Decimal
fiveYears: Decimal
last: Decimal
lastClosing: Decimal
lastClosingDate: DateRepresentation
lastPeriodUpdate: DateRepresentation
lastValueUpdated: DateTimeRepresentation
oneMonth: Decimal
oneYear: Decimal
sell: Decimal
sixMonths: Decimal
thisYear: Decimal
threeMonths: Decimal
threeYears: Decimal
Example
{
  "buy": "number (double)",
  "currency": "string",
  "currencyExchangeRate": "number (double)",
  "fiveYears": "number (double)",
  "last": "number (double)",
  "lastClosing": "number (double)",
  "lastClosingDate": "string",
  "lastPeriodUpdate": "string",
  "lastValueUpdated": "string",
  "oneMonth": "number (double)",
  "oneYear": "number (double)",
  "sell": "number (double)",
  "sixMonths": "number (double)",
  "thisYear": "number (double)",
  "threeMonths": "number (double)",
  "threeYears": "number (double)"
}

AssetValueIdentifier: object

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
ticker: string
Example
{
  "currency": "string",
  "ticker": "string"
}

AsyncTaskCreate: object

payload: AsyncTaskPayload
type: string TEST, DIVIDEND, BG_MAX, AGX, DISTRIBUTION
Example
{
  "payload": "object",
  "type": "string"
}

AsyncTaskPayload: object

Example
"object"

AsyncTaskQueryFilter: object

identifier: string
status: string[]
string NEW, PREPROCESSING, IDLE, PROCESSING, COMPLETED, PARTIALLY_COMPLETED, CANCELED, FAILED
type: string[]
string TEST, DIVIDEND, BG_MAX, AGX, DISTRIBUTION
Example
{
  "identifier": "string",
  "status": [
    "string"
  ],
  "type": [
    "string"
  ]
}

AsyncTaskResultItem«object»: object

identifier: string
payload: object
Example
{
  "identifier": "string",
  "payload": "object"
}

AsyncTaskResultSet«object»: object

page: TokenizedPage«AsyncTaskResultItem«object»»
resultType: string PREPROCESS, PROCESS
taskId: string
type: string TEST, DIVIDEND, BG_MAX, AGX, DISTRIBUTION
Example
{
  "page": {
    "content": [
      {
        "identifier": "string",
        "payload": "object"
      }
    ],
    "first": "boolean",
    "last": "boolean",
    "nextToken": "string",
    "size": "integer (int32)",
    "token": "string",
    "totalSize": "integer (int32)"
  },
  "resultType": "string",
  "taskId": "string",
  "type": "string"
}

AsyncTask«object»: object

created: DateTimeRepresentation
creator: string
id: string
identifier: string
message: string
payload: object
status: string NEW, PREPROCESSING, IDLE, PROCESSING, COMPLETED, PARTIALLY_COMPLETED, CANCELED, FAILED
type: string TEST, DIVIDEND, BG_MAX, AGX, DISTRIBUTION
updated: DateTimeRepresentation
Example
{
  "created": "string",
  "creator": "string",
  "id": "string",
  "identifier": "string",
  "message": "string",
  "payload": "object",
  "status": "string",
  "type": "string",
  "updated": "string"
}

AuthCertificate: object

authorities: string[]
string
certData: string
certId: string
clientIds: string[]
string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
created: integer (int64)
name: string
Example
{
  "authorities": [
    "string"
  ],
  "certData": "string",
  "certId": "string",
  "clientIds": [
    "string"
  ],
  "created": "integer (int64)",
  "name": "string"
}

AutoGiroFile: object

content: string
fileType: string APPROVAL_REQUEST, WITHDRAWAL_REQUEST, PAYMENT_SPECIFICATION, PAYMENT_MODIFICATION, BG_MAX
Example
{
  "content": "string",
  "fileType": "string"
}

AutogiroApprovalRequestResponseItem: object

bankAccount: BankAccount
commentCode: string CANCELED_BY_PAYER, INVALID_BANK_ACCOUNT_TYPE, MISSING_APPROVAL, INVALID_ACCOUNT_OR_PAYER_IDENTIFIER, CANCELED_NO_REQUEST_RESPONSE, UNKNOWN_BANK_GIRO, APPROVAL_ALREADY_ADDED_OR_PENDING, INVALID_PAYER_IDENTIFIER, INVALID_PAYER_ID, INVALID_BANKACCOUNT_NUMBER, INVALID_BANKGIRO, TERMINATED_BANKGIRO, NEW_APPROVAL, CANCELED, CANCLED_BY_TERMINATED_BANK_GIRO, ERROR
errorMessage: string
informationCode: string CANCELED_BY_RECEIVER, ADDED_BY_RECEIVER, PAYER_ID_UPDATE, CANCELED_RECEIVING_BG_TERMINATED, ACCOUNT_INFO_RESPONSE, CANCELED_NO_REQUEST_RESPONSE, CANCELED_BY_PAYER_BG_TERMINATED, CANCELED_BY_PAYER, ERROR
status: string UNMODIFIED, APPROVED, CANCELED, ERROR
Example
{
  "bankAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "commentCode": "string",
  "errorMessage": "string",
  "informationCode": "string",
  "status": "string"
}

BalanceCheckpoint: object

balanceDate: DateTimeRepresentation
checkBalanceTargetValue: object
Example
{
  "balanceDate": "string",
  "checkBalanceTargetValue": "object"
}

BankAccount: object

accountNumber: string
autogiroPayerId: integer (int64)
autogiroStatus: string NONE, PENDING, EXPORTED, ACTIVE, ERROR, ERROR_BAD_ACC_TYPE, ERROR_INVALID_ACC, ERROR_INVALID_IDENTIFIER, ERROR_INVALID_BANKACCOUNT_NUMBER, PENDING_CANCEL, CANCELED, PENDING_CANCEL_BY_USER, CANCELED_BY_USER, PENDING_CANCEL_BY_ADMIN, CANCELED_BY_ADMIN, CANCELED_BY_EXTERNAL
bankIdentifier: string AMFA, AVANZA, BLUE_STEP_FINANS, BNP_PARIBAS_FORTIS_BANK, CITIBANK, DANSKE_BANK, DNB_BANK, EKOBANKEN, FOREX_BANK, ICA_BANKEN_AB, IKANO_BANK, JAK_MEDLEMSBANK, LANDSHYPOTEK_AB, LAN_SPAR_BANK_SVERIGE, LANSFORSAKRINGAR_BANK, MARGINALEN_BANK, NORDAX_BANK, NORDEA, NORDNET_BANK, RESURS_BANK, SANTANDER_CONSUMER_BANK, SEB, SKANDIABANKEN, SWEDBANK, ALANDSBANKEN_SVERIGE, HANDELSBANKEN, SPARBANKEN_SYD, SBAB
clearingNumber: string
created: DateTimeRepresentation
name: string
primary: boolean
signature: string
userUuid: string
uuid: string
Example
{
  "accountNumber": "string",
  "autogiroPayerId": "integer (int64)",
  "autogiroStatus": "string",
  "bankIdentifier": "string",
  "clearingNumber": "string",
  "created": "string",
  "name": "string",
  "primary": "boolean",
  "signature": "string",
  "userUuid": "string",
  "uuid": "string"
}

BankIdInitRequest: object

allowedUnauthorized: boolean
personalNumber: SwedishPersonalNumber
requestType: string
Example
{
  "allowedUnauthorized": "boolean",
  "personalNumber": "string",
  "requestType": "string"
}

BankIdInitResponse: object

autoStartToken: string
bankIdInitStatus: string success, error
bankIdMessage: string rp_error, rfa1, rfa3, rfa4, rfa5, rfa6, rfa8, rfa9, rfa14, rfa15, rfa16, rfa17, rfa21, rfa22
pollToken: string
Example
{
  "autoStartToken": "string",
  "bankIdInitStatus": "string",
  "bankIdMessage": "string",
  "pollToken": "string"
}

BankIdInitVerifyCustomerRequest: object

allowedUnauthorized: boolean
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
initiator: string USER, RP
personalNumber: SwedishPersonalNumber
requestType: string
userId: string
Example
{
  "allowedUnauthorized": "boolean",
  "clientId": "string",
  "initiator": "string",
  "personalNumber": "string",
  "requestType": "string",
  "userId": "string"
}

BankIdPollRequest: object

pollToken: string
Example
{
  "pollToken": "string"
}

BankIdPollResponse: object

bankIdMessage: string rp_error, rfa1, rfa3, rfa4, rfa5, rfa6, rfa8, rfa9, rfa14, rfa15, rfa16, rfa17, rfa21, rfa22
bankIdPollStatus: string outstanding, sign, complete, error
pollData: PollData
userData: UserData
verifiedCustomer: User
Example
{
  "bankIdMessage": "string",
  "bankIdPollStatus": "string",
  "pollData": {
    "autoStartToken": "string",
    "qrToken": "string"
  },
  "userData": {
    "expires": "integer (int64)",
    "roles": [
      "string"
    ],
    "subject": "string"
  },
  "verifiedCustomer": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}

BwDocument: object

category: string PRE_SALES_AGREEMENT, INVESTMENT_INSTRUCTION, AGREEMENT_CUSTOMER, AGREEMENT_ACCOUNT, AGREEMENT_OTHER, CAPITAL_ADEQUACY_REPORT, OTHER
contentType: string
created: DateTimeRepresentation
deprecated: boolean
description: string
fileName: string
hash: string
hashAlg: string md5
title: string
type: string PORTFOLIO, GENERIC
typeMeta: BwDocumentTypeMeta
uuid: string
Example
{
  "category": "string",
  "contentType": "string",
  "created": "string",
  "deprecated": "boolean",
  "description": "string",
  "fileName": "string",
  "hash": "string",
  "hashAlg": "string",
  "title": "string",
  "type": "string",
  "typeMeta": "object",
  "uuid": "string"
}

BwDocumentPatch: object

category: FieldPatch«string»
deprecated: FieldPatch«boolean»
description: FieldPatch«string»
title: FieldPatch«string»
type: FieldPatch«string»
typeMeta: FieldPatch«BwDocumentTypeMeta»
Example
{
  "category": {
    "action": "string",
    "value": "string"
  },
  "deprecated": {
    "action": "string",
    "value": "boolean"
  },
  "description": {
    "action": "string",
    "value": "string"
  },
  "title": {
    "action": "string",
    "value": "string"
  },
  "type": {
    "action": "string",
    "value": "string"
  },
  "typeMeta": {
    "action": "string",
    "value": "object"
  }
}

BwDocumentTypeMeta: object

Example
"object"

BwFile: object

contentType: string
created: DateTimeRepresentation
error: string
fileContentIdentifier: FileContentIdentifier
fileName: string
fileSourceIdentifier: FileSourceIdentifier
id: string
status: string uploaded, processed, unprocessed, process_error
type: string trade_report, trade_settlement, cash_transactions, holdings, withdrawal_request, approval_request, bg_max, payment_specification, payment_modification, iso22002
Example
{
  "contentType": "string",
  "created": "string",
  "error": "string",
  "fileContentIdentifier": {
    "identifier": "string",
    "protocol": "string"
  },
  "fileName": "string",
  "fileSourceIdentifier": {
    "identifier": "string",
    "protocol": "string"
  },
  "id": "string",
  "status": "string",
  "type": "string"
}

CSVDataContainer: object

data: string
Example
{
  "data": "string"
}

CSVDataUploadResponse: object

records: integer (int32)
success: boolean
Example
{
  "records": "integer (int32)",
  "success": "boolean"
}

CashReservations: object

feeAmount: Decimal
settlementAmount: Decimal
totalAmount: Decimal
withdrawalAmount: Decimal
Example
{
  "feeAmount": "number (double)",
  "settlementAmount": "number (double)",
  "totalAmount": "number (double)",
  "withdrawalAmount": "number (double)"
}

ContactPerson: object

email: string
imageUrl: string
name: string
phone: string
uuid: string
Example
{
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "phone": "string",
  "uuid": "string"
}

CreateData: object

content: TemplateContent
contentType: string EMAIL_TEMPLATE, PLAIN, MESSAGE
expiration: DateRepresentation
name: string
type: string NEWS, CORP_ACTION, GENERIC, IMPORTANT
Example
{
  "content": "object",
  "contentType": "string",
  "expiration": "string",
  "name": "string",
  "type": "string"
}

CustomTemplateDistribution: object

alternatives: integer (int32)
commodities: integer (int32)
equity: integer (int32)
fixedIncome: integer (int32)
Example
{
  "alternatives": "integer (int32)",
  "commodities": "integer (int32)",
  "equity": "integer (int32)",
  "fixedIncome": "integer (int32)"
}

CustomTemplateLogEntry«object»: object

logEntryType: string CREATE, UPDATE, ASSET_UPDATE, UPDATE_TRADED, UPDATE_ACCESSIBILITY, UPDATE_SHARED_STATUS, UPDATE_META, COMMENT, DELISTED, DELETE
ownerId: string
payload: object
templateId: string
timestamp: integer (int64)
type: string
uuid: string
Example
{
  "logEntryType": "string",
  "ownerId": "string",
  "payload": "object",
  "templateId": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "uuid": "string"
}

CustomTemplateLogFilter: object

minTimestamp: DateTimeRepresentation
types: string[]
string CREATE, UPDATE, ASSET_UPDATE, UPDATE_TRADED, UPDATE_ACCESSIBILITY, UPDATE_SHARED_STATUS, UPDATE_META, COMMENT, DELISTED, DELETE
Example
{
  "minTimestamp": "string",
  "types": [
    "string"
  ]
}

CustomTemplateMetric: object

aum: Decimal
dateTime: DateTimeRepresentation
distribution: CustomTemplateDistribution
followers: integer (int32)
Example
{
  "aum": "number (double)",
  "dateTime": "string",
  "distribution": {
    "alternatives": "integer (int32)",
    "commodities": "integer (int32)",
    "equity": "integer (int32)",
    "fixedIncome": "integer (int32)"
  },
  "followers": "integer (int32)"
}

CustomTemplatePortfolioFilter: object

accessibility: string[]
string private, public, delisted
category: string[]
string growth, quality, value, momentum, low_volaty, index, stock_picking, esg, multi_asset, quantitative, all_weather, investment_companies, dividend, large_cap, small_cap, bank_finance, groceries, tech, gaming, health_tech, real_estate, industry, it, fintech, food, communication, travel, biotech, luxury, private_equity, medicine, commodities, car, automation_n_robotics, solar, energy, agriculture, infrastructure
invertOrder: boolean
order: string NAME, CREATED, TER, RETURN_ONE_MONTH, RETURN_THREE_MONTHS, RETURN_SIX_MONTHS, RETURN_THIS_YEAR, RETURN_ONE_YEAR, RETURN_THREE_YEARS, RETURN_FIVE_YEARS, GRADE, RANK, FOLLOWERS, AUM
ownerId: string
searchQuery: string
templateIds: string[]
string
Example
{
  "accessibility": [
    "string"
  ],
  "category": [
    "string"
  ],
  "invertOrder": "boolean",
  "order": "string",
  "ownerId": "string",
  "searchQuery": "string",
  "templateIds": [
    "string"
  ]
}

CustomTemplatePortfolioMeta: object

assetTypes: string[]
string ETF, ETF_TEMP, CASH, STOCK, FUND
categories: string[]
string growth, quality, value, momentum, low_volaty, index, stock_picking, esg, multi_asset, quantitative, all_weather, investment_companies, dividend, large_cap, small_cap, bank_finance, groceries, tech, gaming, health_tech, real_estate, industry, it, fintech, food, communication, travel, biotech, luxury, private_equity, medicine, commodities, car, automation_n_robotics, solar, energy, agriculture, infrastructure
description: string
grade: integer (int32)
name: string
rank: integer (int32)
sri: boolean
status: SharedPortfolioStatus
Example
{
  "assetTypes": [
    "string"
  ],
  "categories": [
    "string"
  ],
  "description": "string",
  "grade": "integer (int32)",
  "name": "string",
  "rank": "integer (int32)",
  "sri": "boolean",
  "status": {
    "level": "string",
    "trigger": "string"
  }
}

CustomTemplatePortfolioSelection: object

type: string SELECT, CREATE
Example
{
  "type": "string"
}

CustomTemplatePortfolioValue: object

aum: Decimal
distribution: CustomTemplateDistribution
fiveYears: Decimal
followers: integer (int32)
lastPeriodUpdate: DateRepresentation
oneMonth: Decimal
oneYear: Decimal
sixMonths: Decimal
thisYear: Decimal
threeMonths: Decimal
threeYears: Decimal
Example
{
  "aum": "number (double)",
  "distribution": {
    "alternatives": "integer (int32)",
    "commodities": "integer (int32)",
    "equity": "integer (int32)",
    "fixedIncome": "integer (int32)"
  },
  "fiveYears": "number (double)",
  "followers": "integer (int32)",
  "lastPeriodUpdate": "string",
  "oneMonth": "number (double)",
  "oneYear": "number (double)",
  "sixMonths": "number (double)",
  "thisYear": "number (double)",
  "threeMonths": "number (double)",
  "threeYears": "number (double)"
}

CustomerAdvice: object

adviceMaterial: CustomerAdviceMaterial
portfolios: PortfolioCreateData
PortfolioCreateData
timestamp: integer (int64)
Example
{
  "adviceMaterial": {
    "accountType": "string",
    "age": "integer (int32)",
    "bearLoss": "string",
    "income": "integer (int32)",
    "monthlyInvestment": "integer (int32)",
    "sri": "boolean",
    "startInvestment": "integer (int32)",
    "strategy": "string",
    "timeHorizon": "integer (int32)"
  },
  "portfolios": [
    {
      "accountType": "string",
      "customTemplateSelection": {
        "type": "string"
      },
      "endDate": "string",
      "goalAmount": "number (double)",
      "initialDeposit": "number (double)",
      "investmentPurpose": "string",
      "investmentStrategyType": "string",
      "lossAbility": "string",
      "monthlyDeposit": "number (double)",
      "monthlyPayout": "number (double)",
      "name": "string",
      "parent": "boolean",
      "parentUuid": "string",
      "payoutEndDate": "string",
      "riskLevel": "string",
      "sri": "boolean",
      "uuid": "string"
    }
  ],
  "timestamp": "integer (int64)"
}

CustomerAdviceMaterial: object

accountType: string isk, isk_limited_tax, entity_depot, pension_insurance, isk_track, entity_depot_track
age: integer (int32)
bearLoss: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
income: integer (int32)
monthlyInvestment: integer (int32)
sri: boolean
startInvestment: integer (int32)
strategy: string STATIC, DYNAMIC
timeHorizon: integer (int32)
Example
{
  "accountType": "string",
  "age": "integer (int32)",
  "bearLoss": "string",
  "income": "integer (int32)",
  "monthlyInvestment": "integer (int32)",
  "sri": "boolean",
  "startInvestment": "integer (int32)",
  "strategy": "string",
  "timeHorizon": "integer (int32)"
}

CustomerDeleteResponse: object

customerId: string
status: string PENDING, DELETED
Example
{
  "customerId": "string",
  "status": "string"
}

CustomerLogEntry: object

customerLogEntryType: string USER_CREATE, USER_LOGIN, USER_LOGIN_ORGANIZATION, USER_SIGN, ADMIN_VIEW_USER_LOGIN, ADMIN_VIEW_ORGANIZATION_LOGIN, USER_RECURRING_TRANSACTION_CANCELED, USER_RECURRING_TRANSACTION_ACTIVATED, USER_AUTOGIRO_CANCELED, USER_AUTOGIRO_ACTIVATED, USER_RECURRING_TRANSACTION_CREATED, USER_RECURRING_TRANSACTION_UPDATED, USER_RECURRING_TRANSACTION_DELETED, USER_DELETE, KNOWLEDGE_UPDATED, USER_UPDATED, USER_MIGRATED, ORGANIZATION_DELETE, ORGANIZATION_CREATED, ORGANIZATION_UPDATED, ORGANIZATION_ROLE_UPDATED, ORGANIZATION_KNOWLEDGE_UPDATED, SALES_TAX_REPORT
customerUuid: string
payload: CustomerLogEntryPayload
timestamp: integer (int64)
type: string
userUuid: string
uuid: string
Example
{
  "customerLogEntryType": "string",
  "customerUuid": "string",
  "payload": "object",
  "timestamp": "integer (int64)",
  "type": "string",
  "userUuid": "string",
  "uuid": "string"
}

CustomerLogEntryPayload: object

Example
"object"

DateRepresentation: string

Date and time in ISO 8601 format

DateTimeRepresentation: string

Date and time in ISO 8601 format

DaySeriesEntry: object

timestamp: integer (int64)
value: Decimal
Example
{
  "timestamp": "integer (int64)",
  "value": "number (double)"
}

Decimal: number (double)

Representad as a double in the API, will be stored as a fixed number (6 decimals) in the database

Example
"number (double)"

DefaultFee: object

fee: Fee
investmentStrategyType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
Example
{
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "investmentStrategyType": "string"
}

DepositTrigger: object

amount: Decimal
recurring: boolean
sourceId: string
triggerType: string CASH_ACCOUNT, BANK_ACCOUNT, BANK_ACCOUNT_AG, SWISH, MANUAL, MONOPOLY, PORTFOLIO_TRADE_ORDER
Example
{
  "amount": "number (double)",
  "recurring": "boolean",
  "sourceId": "string",
  "triggerType": "string"
}

External: object

email: string
imageUrl: string
name: string
phone: string
Example
{
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "phone": "string"
}

Fee: object

fixedTradeFee: FixedTradeFee
managementFee: Decimal
noValueBasedDiscount: boolean
safekeepingFee: Decimal
tradeFeesNotIncluded: boolean
valueBasedDiscount: Decimal
vat: Decimal
Example
{
  "fixedTradeFee": {
    "exchangeFee": "number (double)",
    "tradeFee": "number (double)"
  },
  "managementFee": "number (double)",
  "noValueBasedDiscount": "boolean",
  "safekeepingFee": "number (double)",
  "tradeFeesNotIncluded": "boolean",
  "valueBasedDiscount": "number (double)",
  "vat": "number (double)"
}

FeeAdjustment: object

amount: Decimal
Example
{
  "amount": "number (double)"
}

FeeDiscount: object

canceled: DateTimeRepresentation
created: DateTimeRepresentation
fee: Fee
id: string
periodEnd: DateRepresentation
periodStart: DateRepresentation
Example
{
  "canceled": "string",
  "created": "string",
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "id": "string",
  "periodEnd": "string",
  "periodStart": "string"
}

FeeDiscountCreateData: object

managementFee: Decimal
periodEnd: DateRepresentation
periodStart: DateRepresentation
safekeepingFee: Decimal
Example
{
  "managementFee": "number (double)",
  "periodEnd": "string",
  "periodStart": "string",
  "safekeepingFee": "number (double)"
}

FeePatch: object

managementFee: FieldPatch«Decimal»
safekeepingFee: FieldPatch«Decimal»
Example
{
  "managementFee": {
    "action": "string",
    "value": "number (double)"
  },
  "safekeepingFee": {
    "action": "string",
    "value": "number (double)"
  }
}

FieldPatch«BwDocumentTypeMeta»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: BwDocumentTypeMeta
Example
{
  "action": "string",
  "value": "object"
}

FieldPatch«DateRepresentation»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: DateRepresentation
Example
{
  "action": "string",
  "value": "string"
}

FieldPatch«Decimal»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: Decimal
Example
{
  "action": "string",
  "value": "number (double)"
}

FieldPatch«FeePatch»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: FeePatch
Example
{
  "action": "string",
  "value": {
    "managementFee": {
      "action": "string",
      "value": "number (double)"
    },
    "safekeepingFee": {
      "action": "string",
      "value": "number (double)"
    }
  }
}

FieldPatch«List«TemplatePortfolioPatchDistributionPart»»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: TemplatePortfolioPatchDistributionPart
TemplatePortfolioPatchDistributionPart
Example
{
  "action": "string",
  "value": [
    {
      "assetId": "string",
      "fraction": "number (double)"
    }
  ]
}

FieldPatch«List«string»»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: string[]
string
Example
{
  "action": "string",
  "value": [
    "string"
  ]
}

FieldPatch«Map«string,boolean»»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: object
Example
{
  "action": "string",
  "value": "object"
}

FieldPatch«NotificationFilter»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: NotificationFilter
Example
{
  "action": "string",
  "value": {
    "filter": "object"
  }
}

FieldPatch«Principal»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: Principal
Example
{
  "action": "string",
  "value": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  }
}

FieldPatch«TargetDistribution»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: TargetDistribution
Example
{
  "action": "string",
  "value": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  }
}

FieldPatch«TemplateContent»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: TemplateContent
Example
{
  "action": "string",
  "value": "object"
}

FieldPatch«TopTraderData»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: TopTraderData
Example
{
  "action": "string",
  "value": {
    "aumFraction": "number (double)",
    "depositFraction": "number (double)",
    "enabled": "boolean",
    "payoutMethod": "string"
  }
}

FieldPatch«ValueAndDate«Decimal»»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: ValueAndDate«Decimal»
Example
{
  "action": "string",
  "value": {
    "date": "string",
    "valid": "boolean",
    "value": "number (double)"
  }
}

FieldPatch«ValueAndDate«Map«string,Decimal»»»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: ValueAndDate«Map«string,Decimal»»
Example
{
  "action": "string",
  "value": {
    "date": "string",
    "valid": "boolean",
    "value": "object"
  }
}

FieldPatch«ValueAndDate«int»»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: ValueAndDate«int»
Example
{
  "action": "string",
  "value": {
    "date": "string",
    "valid": "boolean",
    "value": "integer (int32)"
  }
}

FieldPatch«boolean»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: boolean
Example
{
  "action": "string",
  "value": "boolean"
}

FieldPatch«int»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: integer (int32)
Example
{
  "action": "string",
  "value": "integer (int32)"
}

FieldPatch«string»: object

action: string NONE, CLEAR, REPLACE, PATCH, PUSH
value: string
Example
{
  "action": "string",
  "value": "string"
}

File: object

absolute: boolean
absoluteFile: File
absolutePath: string
canonicalFile: File
canonicalPath: string
directory: boolean
file: boolean
freeSpace: integer (int64)
hidden: boolean
name: string
parent: string
parentFile: File
path: string
totalSpace: integer (int64)
usableSpace: integer (int64)
Example
{
  "absolute": "boolean",
  "absoluteFile": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "absolutePath": "string",
  "canonicalFile": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "canonicalPath": "string",
  "directory": "boolean",
  "file": "boolean",
  "freeSpace": "integer (int64)",
  "hidden": "boolean",
  "name": "string",
  "parent": "string",
  "parentFile": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "path": "string",
  "totalSpace": "integer (int64)",
  "usableSpace": "integer (int64)"
}

FileContentIdentifier: object

identifier: string
protocol: string asset
Example
{
  "identifier": "string",
  "protocol": "string"
}

FileSourceIdentifier: object

identifier: string
protocol: string email, sftp, user
Example
{
  "identifier": "string",
  "protocol": "string"
}

FixedTradeFee: object

exchangeFee: Decimal
tradeFee: Decimal
Example
{
  "exchangeFee": "number (double)",
  "tradeFee": "number (double)"
}

GenericResponse: object

value: string SUCCESS, NO_UPDATE, NOT_FOUND, ERROR
Example
{
  "value": "string"
}

GenericResponseWithData«Decimal»: object

data: Decimal
value: string SUCCESS, NO_UPDATE, NOT_FOUND, ERROR
Example
{
  "data": "number (double)",
  "value": "string"
}

GenericResponseWithData«string»: object

data: string
value: string SUCCESS, NO_UPDATE, NOT_FOUND, ERROR
Example
{
  "data": "string",
  "value": "string"
}

HistoryCacheStatus: object

firstUpdate: integer (int64)
lastUpdate: integer (int64)
status: string MISSING, EXPIRED, INCOMPLETE, VALID
Example
{
  "firstUpdate": "integer (int64)",
  "lastUpdate": "integer (int64)",
  "status": "string"
}

IdentifiableGenericResponse: object

uuid: string
value: string SUCCESS, NO_UPDATE, NOT_FOUND, ERROR
Example
{
  "uuid": "string",
  "value": "string"
}

IncludedPortfolioTradeOrder: object

portfolioId: string
portfolioTradeOrderId: string
Example
{
  "portfolioId": "string",
  "portfolioTradeOrderId": "string"
}

InputStream: object

Example
"object"

InputStreamResource: object

description: string
file: File
filename: string
inputStream: InputStream
open: boolean
readable: boolean
uri: URI
url: URL
Example
{
  "description": "string",
  "file": {
    "absolute": "boolean",
    "absoluteFile": "#/definitions/File",
    "absolutePath": "string",
    "canonicalFile": "#/definitions/File",
    "canonicalPath": "string",
    "directory": "boolean",
    "file": "boolean",
    "freeSpace": "integer (int64)",
    "hidden": "boolean",
    "name": "string",
    "parent": "string",
    "parentFile": "#/definitions/File",
    "path": "string",
    "totalSpace": "integer (int64)",
    "usableSpace": "integer (int64)"
  },
  "filename": "string",
  "inputStream": "object",
  "open": "boolean",
  "readable": "boolean",
  "uri": {
    "absolute": "boolean",
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": "boolean",
    "path": "string",
    "port": "integer (int32)",
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": "object",
    "defaultPort": "integer (int32)",
    "file": "string",
    "host": "string",
    "path": "string",
    "port": "integer (int32)",
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}

InternalAssetCacheStatusRepresentation: object

assetId: string
historyStatus: HistoryCacheStatus
periodHistoryStatus: ValueCacheStatus
valueStatus: ValueCacheStatus
Example
{
  "assetId": "string",
  "historyStatus": {
    "firstUpdate": "integer (int64)",
    "lastUpdate": "integer (int64)",
    "status": "string"
  },
  "periodHistoryStatus": {
    "lastUpdate": "integer (int64)",
    "status": "string"
  },
  "valueStatus": {
    "lastUpdate": "integer (int64)",
    "status": "string"
  }
}

InternalAssetHistoryRequestRepresentation: object

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
endDate: DateTimeRepresentation
startDate: DateTimeRepresentation
Example
{
  "currency": "string",
  "endDate": "string",
  "startDate": "string"
}

InternalAssetStorageItemRepresentation: object

amount: Decimal
assetId: string
id: string
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "id": "string"
}

InternalDocumentGroupRepresentation: object

documents: BwDocument
BwDocument
groupId: SignableGroupId
groupType: string SIGN_UP, AUTO_GIRO, ADD_PORTFOLIO, ADD_PENSION_INSURANCE, SIGN_UP_ORG, ADD_ENTITY_DEPOT_PORTFOLIO
majorVersion: integer (int32)
minorVersion: integer (int32)
uuid: string
Example
{
  "documents": [
    {
      "category": "string",
      "contentType": "string",
      "created": "string",
      "deprecated": "boolean",
      "description": "string",
      "fileName": "string",
      "hash": "string",
      "hashAlg": "string",
      "title": "string",
      "type": "string",
      "typeMeta": "object",
      "uuid": "string"
    }
  ],
  "groupId": {
    "groupId": "string",
    "groupType": "string",
    "major": "integer (int32)",
    "minor": "integer (int32)"
  },
  "groupType": "string",
  "majorVersion": "integer (int32)",
  "minorVersion": "integer (int32)",
  "uuid": "string"
}

InternalDocumentGroupUpdateRepresentation: object

documents: string[]
string
newMajor: boolean
type: string SIGN_UP, AUTO_GIRO, ADD_PORTFOLIO, ADD_PENSION_INSURANCE, SIGN_UP_ORG, ADD_ENTITY_DEPOT_PORTFOLIO
Example
{
  "documents": [
    "string"
  ],
  "newMajor": "boolean",
  "type": "string"
}

InternalPageRepresentationAdminLogEntry: object

content: AdminLogEntry
AdminLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationBankAccount: object

content: BankAccount
BankAccount
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationCustomerLogEntry: object

content: CustomerLogEntry
CustomerLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "customerLogEntryType": "string",
      "customerUuid": "string",
      "payload": "object",
      "timestamp": "integer (int64)",
      "type": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationInternalTradeOrderListItemRepresentation: object

content: InternalTradeOrderListItemRepresentation
InternalTradeOrderListItemRepresentation
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "hasError": "boolean",
      "parentOrderId": "string",
      "status": "string",
      "tradeOrderId": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationMarketTradeOrder: object

content: MarketTradeOrder
MarketTradeOrder
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "children": [
        "#/definitions/MarketTradeOrder"
      ],
      "completedOrders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "baseTradeFee": "number (double)",
          "currency": "string",
          "currencyConversionFee": "number (double)",
          "currencyConversionRatio": "number (double)",
          "itemId": "string",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "settlementTimestamp": "integer (int64)",
          "state": "string",
          "tradeFee": "number (double)",
          "tradeMethod": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "created": "string",
      "orderType": "string",
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "estimateAbsAmount": "number (double)",
          "estimatedPrice": "number (double)",
          "tradeMethod": "string",
          "type": "string",
          "unit": "string"
        }
      ],
      "parentOrderId": "string",
      "status": "string",
      "uuid": "string",
      "version": "integer (int32)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationPortfolioLogEntry: object

content: PortfolioLogEntry
PortfolioLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationRecurringTransaction: object

content: PortfolioLogEntry
PortfolioLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationSuspiciousTransaction: object

content: SuspiciousTransaction
SuspiciousTransaction
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "id": "string",
      "status": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationTransaction: object

content: Transaction
Transaction
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationUser: object

content: User
User
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "userProfileAlias": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationUserWithKYC: object

content: UserWithKYC
UserWithKYC
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "kyc": {
        "responseItems": [
          {
            "hitRating": "integer (int32)",
            "itemType": "string",
            "listType": "string",
            "name": "string",
            "sourceName": "string"
          }
        ]
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentationUserWithKnowledge: object

content: UserWithKnowledge
UserWithKnowledge
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«AdminLogEntry»: object

content: AdminLogEntry
AdminLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«BankAccount»: object

content: BankAccount
BankAccount
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«CustomerLogEntry»: object

content: CustomerLogEntry
CustomerLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "customerLogEntryType": "string",
      "customerUuid": "string",
      "payload": "object",
      "timestamp": "integer (int64)",
      "type": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«InternalTradeOrderListItemRepresentation»: object

content: InternalTradeOrderListItemRepresentation
InternalTradeOrderListItemRepresentation
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "hasError": "boolean",
      "parentOrderId": "string",
      "status": "string",
      "tradeOrderId": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«MarketTradeOrder»: object

content: MarketTradeOrder
MarketTradeOrder
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "children": [
        "#/definitions/MarketTradeOrder"
      ],
      "completedOrders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "baseTradeFee": "number (double)",
          "currency": "string",
          "currencyConversionFee": "number (double)",
          "currencyConversionRatio": "number (double)",
          "itemId": "string",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "settlementTimestamp": "integer (int64)",
          "state": "string",
          "tradeFee": "number (double)",
          "tradeMethod": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "created": "string",
      "orderType": "string",
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "estimateAbsAmount": "number (double)",
          "estimatedPrice": "number (double)",
          "tradeMethod": "string",
          "type": "string",
          "unit": "string"
        }
      ],
      "parentOrderId": "string",
      "status": "string",
      "uuid": "string",
      "version": "integer (int32)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«PortfolioLogEntry»: object

content: PortfolioLogEntry
PortfolioLogEntry
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«RecurringTransaction»: object

content: RecurringTransaction
RecurringTransaction
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "bankAccountId": "string",
      "created": "string",
      "paused": "boolean",
      "portfolioIndex": "integer (int32)",
      "protocol": "string",
      "status": "string",
      "transactionDay": "integer (int32)",
      "type": "string",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«SuspiciousTransaction»: object

content: SuspiciousTransaction
SuspiciousTransaction
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "id": "string",
      "status": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«Transaction»: object

content: Transaction
Transaction
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«UserWithKYC»: object

content: UserWithKYC
UserWithKYC
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "kyc": {
        "responseItems": [
          {
            "hitRating": "integer (int32)",
            "itemType": "string",
            "listType": "string",
            "name": "string",
            "sourceName": "string"
          }
        ]
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«UserWithKnowledge»: object

content: UserWithKnowledge
UserWithKnowledge
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPageRepresentation«User»: object

content: User
User
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "userProfileAlias": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

InternalPortfolioTradeErrorRepresentation: object

errorMessage: string
portfolioId: string
Example
{
  "errorMessage": "string",
  "portfolioId": "string"
}

InternalPortfolioTradeRepresentation: object

orders: InternalTradeOrderResultItemRepresentation
InternalTradeOrderResultItemRepresentation
portfolioId: string
Example
{
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "currencyFee": "number (double)",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "savedCurrencyFee": "number (double)",
      "savedTradeFee": "number (double)",
      "settlementTimestamp": "integer (int64)",
      "tradeFee": "number (double)",
      "tradeFeeType": "string",
      "tradeMethod": "string",
      "tradeOrderId": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "portfolioId": "string"
}

InternalTradeOrderListItemRepresentation: object

created: DateTimeRepresentation
hasError: boolean
parentOrderId: string
status: string
tradeOrderId: string
type: string MARKET_EXCHANGE, MARKET_FUND, MARKET_FX, INTERNAL
Example
{
  "created": "string",
  "hasError": "boolean",
  "parentOrderId": "string",
  "status": "string",
  "tradeOrderId": "string",
  "type": "string"
}

InternalTradeOrderRepresentation: object

created: DateTimeRepresentation
errors: InternalPortfolioTradeErrorRepresentation
InternalPortfolioTradeErrorRepresentation
marketOrderId: string
orders: InternalTradeOrderResultItemRepresentation
InternalTradeOrderResultItemRepresentation
portfolios: InternalPortfolioTradeRepresentation
InternalPortfolioTradeRepresentation
status: string
tradeOrderId: string
Example
{
  "created": "string",
  "errors": [
    {
      "errorMessage": "string",
      "portfolioId": "string"
    }
  ],
  "marketOrderId": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "currencyFee": "number (double)",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "savedCurrencyFee": "number (double)",
      "savedTradeFee": "number (double)",
      "settlementTimestamp": "integer (int64)",
      "tradeFee": "number (double)",
      "tradeFeeType": "string",
      "tradeMethod": "string",
      "tradeOrderId": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "portfolios": [
    {
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "currencyFee": "number (double)",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "savedCurrencyFee": "number (double)",
          "savedTradeFee": "number (double)",
          "settlementTimestamp": "integer (int64)",
          "tradeFee": "number (double)",
          "tradeFeeType": "string",
          "tradeMethod": "string",
          "tradeOrderId": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "portfolioId": "string"
    }
  ],
  "status": "string",
  "tradeOrderId": "string"
}

InternalTradeOrderResultItemRepresentation: object

amount: Decimal
assetId: string
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
currencyExchangeRate: Decimal
currencyFee: Decimal
marketplace: string[]
string
price: Decimal
priceSource: string market, internal, manual
savedCurrencyFee: Decimal
savedTradeFee: Decimal
settlementTimestamp: integer (int64)
tradeFee: Decimal
tradeFeeType: string NONE, CONTENT_BASED, FIXED
tradeMethod: string market, internal
tradeOrderId: string
tradedTimestamp: integer (int64)
type: string BUY, SELL, FAILED, NONE
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "currency": "string",
  "currencyExchangeRate": "number (double)",
  "currencyFee": "number (double)",
  "marketplace": [
    "string"
  ],
  "price": "number (double)",
  "priceSource": "string",
  "savedCurrencyFee": "number (double)",
  "savedTradeFee": "number (double)",
  "settlementTimestamp": "integer (int64)",
  "tradeFee": "number (double)",
  "tradeFeeType": "string",
  "tradeMethod": "string",
  "tradeOrderId": "string",
  "tradedTimestamp": "integer (int64)",
  "type": "string"
}

InternalValueHistoryRepresentation: object

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
endDate: DateTimeRepresentation
startDate: DateTimeRepresentation
values: TimeSeriesEntry
TimeSeriesEntry
Example
{
  "currency": "string",
  "endDate": "string",
  "startDate": "string",
  "values": [
    {
      "dateTime": "string",
      "value": "number (double)"
    }
  ]
}

InternalValueRepresentation: object

buy: Decimal
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
currencyExchangeRate: Decimal
last: Decimal
lastValueUpdated: DateTimeRepresentation
sell: Decimal
Example
{
  "buy": "number (double)",
  "currency": "string",
  "currencyExchangeRate": "number (double)",
  "last": "number (double)",
  "lastValueUpdated": "string",
  "sell": "number (double)"
}

Invoice: object

accountNumber: string
adjustedAmount: Decimal
amount: Decimal
created: DateRepresentation
dueDate: DateRepresentation
invoiceNumber: integer (int32)
legalIdentifier: integer (int64)
logItemId: string
name: string
ownerId: string
paymentAccount: string
paymentId: string
periodEndDate: DateRepresentation
periodStartDate: DateRepresentation
portfolioId: string
portfolioName: string
transactionId: string
transactionStatus: string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
transferredAmount: Decimal
vat: Decimal
Example
{
  "accountNumber": "string",
  "adjustedAmount": "number (double)",
  "amount": "number (double)",
  "created": "string",
  "dueDate": "string",
  "invoiceNumber": "integer (int32)",
  "legalIdentifier": "integer (int64)",
  "logItemId": "string",
  "name": "string",
  "ownerId": "string",
  "paymentAccount": "string",
  "paymentId": "string",
  "periodEndDate": "string",
  "periodStartDate": "string",
  "portfolioId": "string",
  "portfolioName": "string",
  "transactionId": "string",
  "transactionStatus": "string",
  "transferredAmount": "number (double)",
  "vat": "number (double)"
}

KYCResponseItem: object

hitRating: integer (int32)
itemType: string INDIVIDUAL, ENTITY
listType: string SANCTION, PEP
name: string
sourceName: string
Example
{
  "hitRating": "integer (int32)",
  "itemType": "string",
  "listType": "string",
  "name": "string",
  "sourceName": "string"
}

KnowledgeTest: object

completionDate: DateTimeRepresentation
questions: KnowledgeTestQuestion
KnowledgeTestQuestion
type: string test, funds, stocks, copy_portfolio, sri_preference
version: integer (int32)
Example
{
  "completionDate": "string",
  "questions": [
    {
      "answerId": "string",
      "questionId": "string"
    }
  ],
  "type": "string",
  "version": "integer (int32)"
}

KnowledgeTestQuestion: object

answerId: string
questionId: string STOCKS, FUNDS, RISK_LOSS, KNOWLEDGE_EXPERIENCE, ECONOMIC_SITUATION, PURPOSE_OF_THE_INVESTMENT, INVESTMENT_BASE, TIME_HORIZON, SIGN_DOCUMENTS, INCLUDE_SRI_PREFERENCE
Example
{
  "answerId": "string",
  "questionId": "string"
}

Lead: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
converted: DateTimeRepresentation
created: DateTimeRepresentation
email: string
id: string
name: string
newsletter: boolean
notifications: boolean
onboarding: boolean
pensionPlan: boolean
phone: string
privacyPolicyAcceptVersion: integer (int32)
shortName: string
uuid: string
Example
{
  "clientId": "string",
  "converted": "string",
  "created": "string",
  "email": "string",
  "id": "string",
  "name": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "onboarding": "boolean",
  "pensionPlan": "boolean",
  "phone": "string",
  "privacyPolicyAcceptVersion": "integer (int32)",
  "shortName": "string",
  "uuid": "string"
}

ManualDepositCreateRepresentation: object

amount: Decimal
depositMessage: string
ownerId: string
portfolioId: string
type: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
Example
{
  "amount": "number (double)",
  "depositMessage": "string",
  "ownerId": "string",
  "portfolioId": "string",
  "type": "string"
}

Map«string,Decimal»: object

Decimal
Example
"object"

Map«string,boolean»: object

boolean
Example
"object"

MarketTradeOrder: object

children: MarketTradeOrder
MarketTradeOrder
completedOrders: MarketTradeOrderItem
MarketTradeOrderItem
created: DateTimeRepresentation
orderType: string asset, fx, fund
orders: TradeOrderItem
TradeOrderItem
parentOrderId: string
status: string PENDING, TRADING, DISTRIBUTING, SEND_REPORT, REPORTING, CLOSED, CANCELED
uuid: string
version: integer (int32)
Example
{
  "children": [
    {
      "children": [
        "#/definitions/MarketTradeOrder"
      ],
      "completedOrders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "baseTradeFee": "number (double)",
          "currency": "string",
          "currencyConversionFee": "number (double)",
          "currencyConversionRatio": "number (double)",
          "itemId": "string",
          "marketplace": [
            "string"
          ],
          "price": "number (double)",
          "priceSource": "string",
          "settlementTimestamp": "integer (int64)",
          "state": "string",
          "tradeFee": "number (double)",
          "tradeMethod": "string",
          "tradedTimestamp": "integer (int64)",
          "type": "string"
        }
      ],
      "created": "string",
      "orderType": "string",
      "orders": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "estimateAbsAmount": "number (double)",
          "estimatedPrice": "number (double)",
          "tradeMethod": "string",
          "type": "string",
          "unit": "string"
        }
      ],
      "parentOrderId": "string",
      "status": "string",
      "uuid": "string",
      "version": "integer (int32)"
    }
  ],
  "completedOrders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ],
  "created": "string",
  "orderType": "string",
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ],
  "parentOrderId": "string",
  "status": "string",
  "uuid": "string",
  "version": "integer (int32)"
}

MarketTradeOrderItem: object

amount: Decimal
assetId: string
baseTradeFee: Decimal
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
currencyConversionFee: Decimal
currencyConversionRatio: Decimal
itemId: string
marketplace: string[]
string
price: Decimal
priceSource: string market, internal, manual
settlementTimestamp: integer (int64)
state: string idle, trading, distributing, cancelled
tradeFee: Decimal
tradeMethod: string market, internal
tradedTimestamp: integer (int64)
type: string BUY, SELL, FAILED, NONE
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "baseTradeFee": "number (double)",
  "currency": "string",
  "currencyConversionFee": "number (double)",
  "currencyConversionRatio": "number (double)",
  "itemId": "string",
  "marketplace": [
    "string"
  ],
  "price": "number (double)",
  "priceSource": "string",
  "settlementTimestamp": "integer (int64)",
  "state": "string",
  "tradeFee": "number (double)",
  "tradeMethod": "string",
  "tradedTimestamp": "integer (int64)",
  "type": "string"
}

MarketTradeOrderReportMeta: object

name: string
Example
{
  "name": "string"
}

MarketTradeOrderUpdate: object

cancelledAffairs: string[]
string
completedAffairs: MarketTradeOrderItem
MarketTradeOrderItem
Example
{
  "cancelledAffairs": [
    "string"
  ],
  "completedAffairs": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "baseTradeFee": "number (double)",
      "currency": "string",
      "currencyConversionFee": "number (double)",
      "currencyConversionRatio": "number (double)",
      "itemId": "string",
      "marketplace": [
        "string"
      ],
      "price": "number (double)",
      "priceSource": "string",
      "settlementTimestamp": "integer (int64)",
      "state": "string",
      "tradeFee": "number (double)",
      "tradeMethod": "string",
      "tradedTimestamp": "integer (int64)",
      "type": "string"
    }
  ]
}

MarketTradeOrderValidationOverride: object

assetId: string
properties: string[]
string
Example
{
  "assetId": "string",
  "properties": [
    "string"
  ]
}

MultipartResponseContainerBwFile: object

calculatedHash: string
providedHash: string
response: BwFile
Example
{
  "calculatedHash": "string",
  "providedHash": "string",
  "response": {
    "contentType": "string",
    "created": "string",
    "error": "string",
    "fileContentIdentifier": {
      "identifier": "string",
      "protocol": "string"
    },
    "fileName": "string",
    "fileSourceIdentifier": {
      "identifier": "string",
      "protocol": "string"
    },
    "id": "string",
    "status": "string",
    "type": "string"
  }
}

MultipartResponseContainer«BwFile»: object

calculatedHash: string
providedHash: string
response: BwFile
Example
{
  "calculatedHash": "string",
  "providedHash": "string",
  "response": {
    "contentType": "string",
    "created": "string",
    "error": "string",
    "fileContentIdentifier": {
      "identifier": "string",
      "protocol": "string"
    },
    "fileName": "string",
    "fileSourceIdentifier": {
      "identifier": "string",
      "protocol": "string"
    },
    "id": "string",
    "status": "string",
    "type": "string"
  }
}

Notification: object

created: DateTimeRepresentation
enabled: boolean
generator: NotificationGenerator
generatorId: string
id: string
ownerId: string
status: string NEW, READ, DELETED
targetId: string
targetType: string CUSTOMER, PORTFOLIO
template: NotificationTemplate
Example
{
  "created": "string",
  "enabled": "boolean",
  "generator": {
    "created": "string",
    "enabled": "boolean",
    "filter": {
      "filter": "object"
    },
    "id": "string",
    "medium": "string",
    "name": "string",
    "period": "string",
    "template": {
      "content": "object",
      "contentType": "string",
      "expiration": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    }
  },
  "generatorId": "string",
  "id": "string",
  "ownerId": "string",
  "status": "string",
  "targetId": "string",
  "targetType": "string",
  "template": {
    "content": "object",
    "contentType": "string",
    "expiration": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
}

NotificationFilter: object

filter: object
Example
{
  "filter": "object"
}

NotificationGenerator: object

created: DateTimeRepresentation
enabled: boolean
filter: NotificationFilter
id: string
medium: string EMAIL, IN_APP
name: string
period: string MANUAL, HOURLY, DAILY, ON_LOGIN
template: NotificationTemplate
Example
{
  "created": "string",
  "enabled": "boolean",
  "filter": {
    "filter": "object"
  },
  "id": "string",
  "medium": "string",
  "name": "string",
  "period": "string",
  "template": {
    "content": "object",
    "contentType": "string",
    "expiration": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
}

NotificationGeneratorPatch: object

enabled: FieldPatch«boolean»
filter: FieldPatch«NotificationFilter»
name: FieldPatch«string»
period: FieldPatch«string»
Example
{
  "enabled": {
    "action": "string",
    "value": "boolean"
  },
  "filter": {
    "action": "string",
    "value": {
      "filter": "object"
    }
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "period": {
    "action": "string",
    "value": "string"
  }
}

NotificationGeneratorTriggerResponse: object

numberOfTriggers: integer (int32)
Example
{
  "numberOfTriggers": "integer (int32)"
}

NotificationHit: object

customerId: string
customerType: string USER, ORGANIZATION, LEAD
targetExternalId: string
targetId: string
targetName: string
targetType: string CUSTOMER, PORTFOLIO
templateValues: object
Example
{
  "customerId": "string",
  "customerType": "string",
  "targetExternalId": "string",
  "targetId": "string",
  "targetName": "string",
  "targetType": "string",
  "templateValues": "object"
}

NotificationTemplate: object

content: TemplateContent
contentType: string EMAIL_TEMPLATE, PLAIN, MESSAGE
expiration: DateRepresentation
id: string
name: string
type: string NEWS, CORP_ACTION, GENERIC, IMPORTANT
Example
{
  "content": "object",
  "contentType": "string",
  "expiration": "string",
  "id": "string",
  "name": "string",
  "type": "string"
}

NotificationTemplatePatch: object

content: FieldPatch«TemplateContent»
contentType: FieldPatch«string»
expiration: FieldPatch«DateRepresentation»
name: FieldPatch«string»
type: FieldPatch«string»
Example
{
  "content": {
    "action": "string",
    "value": "object"
  },
  "contentType": {
    "action": "string",
    "value": "string"
  },
  "expiration": {
    "action": "string",
    "value": "string"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "type": {
    "action": "string",
    "value": "string"
  }
}

OrderEstimateItem: object

amount: Decimal
assetId: string
currencyExchangeFee: Decimal
currencyExchangeRate: PriceEstimate
price: PriceEstimate
tradeFee: Decimal
type: string BUY, SELL, FAILED, NONE
value: Decimal
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "currencyExchangeFee": "number (double)",
  "currencyExchangeRate": {
    "price": "number (double)",
    "timestamp": "string"
  },
  "price": {
    "price": "number (double)",
    "timestamp": "string"
  },
  "tradeFee": "number (double)",
  "type": "string",
  "value": "number (double)"
}

Organization: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
email: string
lei: string
name: string
organizationNumber: OrganizationNumber
principal: Principal
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
status: string pending, reviewing, active, pending_delete, deleted, stale
uuid: string
Example
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "uuid": "string"
}

OrganizationAdminPatch: object

email: FieldPatch«string»
lei: FieldPatch«string»
name: FieldPatch«string»
principal: FieldPatch«Principal»
riskCategory: FieldPatch«string»
status: FieldPatch«string»
Example
{
  "email": {
    "action": "string",
    "value": "string"
  },
  "lei": {
    "action": "string",
    "value": "string"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "principal": {
    "action": "string",
    "value": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    }
  },
  "riskCategory": {
    "action": "string",
    "value": "string"
  },
  "status": {
    "action": "string",
    "value": "string"
  }
}

OrganizationCreateData: object

knowledge: OrganizationKnowledgePatch
organization: Organization
Example
{
  "knowledge": {
    "cashSources": {
      "action": "string",
      "value": "object"
    },
    "insolvencyProbability": {
      "action": "string",
      "value": "boolean"
    },
    "investmentSize": {
      "action": "string",
      "value": "string"
    },
    "managingCash": {
      "action": "string",
      "value": "boolean"
    }
  },
  "organization": {
    "clientId": "string",
    "confirmEmail": "string",
    "created": "string",
    "email": "string",
    "lei": "string",
    "name": "string",
    "organizationNumber": {
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string",
      "vatnumber": "string"
    },
    "principal": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    },
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "status": "string",
    "uuid": "string"
  }
}

OrganizationKnowledge: object

cashSources: object
insolvencyProbability: boolean
investmentSize: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
lastUpdated: DateTimeRepresentation
managingCash: boolean
version: integer (int32)
Example
{
  "cashSources": "object",
  "insolvencyProbability": "boolean",
  "investmentSize": "string",
  "lastUpdated": "string",
  "managingCash": "boolean",
  "version": "integer (int32)"
}

OrganizationKnowledgePatch: object

cashSources: FieldPatch«Map«string,boolean»»
insolvencyProbability: FieldPatch«boolean»
investmentSize: FieldPatch«string»
managingCash: FieldPatch«boolean»
Example
{
  "cashSources": {
    "action": "string",
    "value": "object"
  },
  "insolvencyProbability": {
    "action": "string",
    "value": "boolean"
  },
  "investmentSize": {
    "action": "string",
    "value": "string"
  },
  "managingCash": {
    "action": "string",
    "value": "boolean"
  }
}

OrganizationListItem: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
created: DateTimeRepresentation
email: string
lei: string
name: string
organizationNumber: OrganizationNumber
principal: Principal
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
status: string pending, reviewing, active, pending_delete, deleted, stale
uuid: string
Example
{
  "clientId": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "uuid": "string"
}

OrganizationNumber: object

canonical: string
canonicalAsLong: integer (int64)
prefix: string
vatnumber: string
Example
{
  "canonical": "string",
  "canonicalAsLong": "integer (int64)",
  "prefix": "string",
  "vatnumber": "string"
}

OrganizationUser: object

lastUpdated: DateTimeRepresentation
organizationId: string
organizationRole: string editor, viewer, none
userId: string
userName: string
uuid: string
Example
{
  "lastUpdated": "string",
  "organizationId": "string",
  "organizationRole": "string",
  "userId": "string",
  "userName": "string",
  "uuid": "string"
}

OrganizationUserData: object

organizationRole: string editor, viewer, none
Example
{
  "organizationRole": "string"
}

OrganizationWithUsers: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
email: string
lei: string
name: string
organizationNumber: OrganizationNumber
principal: Principal
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
status: string pending, reviewing, active, pending_delete, deleted, stale
users: OrganizationUser
OrganizationUser
uuid: string
Example
{
  "clientId": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}

PatchSetItem«AssetESGDataPatch»: object

patch: AssetESGDataPatch
uuid: string
Example
{
  "patch": {
    "msciEsgDataDate": {
      "action": "string",
      "value": "string"
    },
    "msciEsgDataPresent": {
      "action": "string",
      "value": "boolean"
    },
    "msciEsgQualityScore": {
      "action": "string",
      "value": "number (double)"
    },
    "msciEsgQualityScorePctlGlobal": {
      "action": "string",
      "value": "number (double)"
    },
    "msciEsgQualityScorePctlPeer": {
      "action": "string",
      "value": "number (double)"
    },
    "msciEsgRating": {
      "action": "string",
      "value": "string"
    },
    "msciSustainableImpactPct": {
      "action": "string",
      "value": "number (double)"
    },
    "msciWaCO2i": {
      "action": "string",
      "value": "number (double)"
    }
  },
  "uuid": "string"
}

PatchSet«AssetESGDataPatch»: object

patches: PatchSetItem«AssetESGDataPatch»
PatchSetItem«AssetESGDataPatch»
Example
{
  "patches": [
    {
      "patch": {
        "msciEsgDataDate": {
          "action": "string",
          "value": "string"
        },
        "msciEsgDataPresent": {
          "action": "string",
          "value": "boolean"
        },
        "msciEsgQualityScore": {
          "action": "string",
          "value": "number (double)"
        },
        "msciEsgQualityScorePctlGlobal": {
          "action": "string",
          "value": "number (double)"
        },
        "msciEsgQualityScorePctlPeer": {
          "action": "string",
          "value": "number (double)"
        },
        "msciEsgRating": {
          "action": "string",
          "value": "string"
        },
        "msciSustainableImpactPct": {
          "action": "string",
          "value": "number (double)"
        },
        "msciWaCO2i": {
          "action": "string",
          "value": "number (double)"
        }
      },
      "uuid": "string"
    }
  ]
}

PendingCustomerDeletion: object

createdTimestamp: integer (int64)
customerId: string
customerType: string USER, ORGANIZATION
deleteTimestamp: integer (int64)
lastTransactionTimestamp: integer (int64)
Example
{
  "createdTimestamp": "integer (int64)",
  "customerId": "string",
  "customerType": "string",
  "deleteTimestamp": "integer (int64)",
  "lastTransactionTimestamp": "integer (int64)"
}

PersonalNumber: object

age: integer (int32)
canonical: string
canonicalAsLong: integer (int64)
prefix: string
Example
{
  "age": "integer (int32)",
  "canonical": "string",
  "canonicalAsLong": "integer (int64)",
  "prefix": "string"
}

PollData: object

autoStartToken: string
qrToken: string
Example
{
  "autoStartToken": "string",
  "qrToken": "string"
}

PortfolioAccountNumber: object

accountNumber: string
Example
{
  "accountNumber": "string"
}

PortfolioBulkActionResponse: object

failureIds: string[]
string
skippedIds: string[]
string
successIds: string[]
string
Example
{
  "failureIds": [
    "string"
  ],
  "skippedIds": [
    "string"
  ],
  "successIds": [
    "string"
  ]
}

PortfolioCreateData: object

accountType: string isk, isk_limited_tax, entity_depot, pension_insurance, isk_track, entity_depot_track
customTemplateSelection: CustomTemplatePortfolioSelection
endDate: DateTimeRepresentation
goalAmount: Decimal
initialDeposit: Decimal
investmentPurpose: string BUFFER, RETIREMENT, GENERAL, CHILD_SAVINGS, OTHER
investmentStrategyType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
lossAbility: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
monthlyDeposit: Decimal
monthlyPayout: Decimal
name: string
parent: boolean
parentUuid: string
payoutEndDate: DateTimeRepresentation
riskLevel: string PORTFOLIO_RISK_LEVEL_FOUR, PORTFOLIO_RISK_LEVEL_FIVE, PORTFOLIO_RISK_LEVEL_SIX, PORTFOLIO_RISK_LEVEL_SEVEN, PORTFOLIO_RISK_LEVEL_EIGHT, PORTFOLIO_RISK_LEVEL_NINE, PORTFOLIO_RISK_LEVEL_TEN, PORTFOLIO_RISK_LEVEL_ELEVEN, PORTFOLIO_RISK_LEVEL_TWELVE, PORTFOLIO_RISK_LEVEL_THIRTEEN, PORTFOLIO_RISK_LEVEL_FOURTEEN, PORTFOLIO_RISK_LEVEL_FIFTEEN, PORTFOLIO_RISK_LEVEL_SIXTEEN, PORTFOLIO_RISK_LEVEL_SEVENTEEN, PORTFOLIO_RISK_LEVEL_EIGHTEEN, PORTFOLIO_RISK_LEVEL_NINETEEN, PORTFOLIO_RISK_LEVEL_TWENTY, PORTFOLIO_RISK_LEVEL_TWENTY_ONE, PORTFOLIO_RISK_LEVEL_TWENTY_TWO, PORTFOLIO_RISK_LEVEL_TWENTY_THREE, PORTFOLIO_RISK_LEVEL_TWENTY_FOUR, PORTFOLIO_RISK_LEVEL_TWENTY_FIVE
sri: boolean
uuid: string
Example
{
  "accountType": "string",
  "customTemplateSelection": {
    "type": "string"
  },
  "endDate": "string",
  "goalAmount": "number (double)",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lossAbility": "string",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "parent": "boolean",
  "parentUuid": "string",
  "payoutEndDate": "string",
  "riskLevel": "string",
  "sri": "boolean",
  "uuid": "string"
}

PortfolioData: object

accountType: string isk, isk_limited_tax, entity_depot, pension_insurance, isk_track, entity_depot_track
assets: PortfolioPart
PortfolioPart
bearLoss: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
deleted: boolean
endDate: integer (int64)
errors: string[]
string
fee: Fee
feeDiscounts: FeeDiscount
FeeDiscount
goalAmount: Decimal
id: string
initialDeposit: Decimal
investmentPurpose: string BUFFER, RETIREMENT, GENERAL, CHILD_SAVINGS, OTHER
investmentStrategyType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
lastUpdate: integer (int64)
monthlyDeposit: Decimal
monthlyPayout: Decimal
name: string
ownerId: string
parent: boolean
parentId: string
payoutEndDate: integer (int64)
portfolioIndex: integer (int32)
riskLevel: string PORTFOLIO_RISK_LEVEL_FOUR, PORTFOLIO_RISK_LEVEL_FIVE, PORTFOLIO_RISK_LEVEL_SIX, PORTFOLIO_RISK_LEVEL_SEVEN, PORTFOLIO_RISK_LEVEL_EIGHT, PORTFOLIO_RISK_LEVEL_NINE, PORTFOLIO_RISK_LEVEL_TEN, PORTFOLIO_RISK_LEVEL_ELEVEN, PORTFOLIO_RISK_LEVEL_TWELVE, PORTFOLIO_RISK_LEVEL_THIRTEEN, PORTFOLIO_RISK_LEVEL_FOURTEEN, PORTFOLIO_RISK_LEVEL_FIFTEEN, PORTFOLIO_RISK_LEVEL_SIXTEEN, PORTFOLIO_RISK_LEVEL_SEVENTEEN, PORTFOLIO_RISK_LEVEL_EIGHTEEN, PORTFOLIO_RISK_LEVEL_NINETEEN, PORTFOLIO_RISK_LEVEL_TWENTY, PORTFOLIO_RISK_LEVEL_TWENTY_ONE, PORTFOLIO_RISK_LEVEL_TWENTY_TWO, PORTFOLIO_RISK_LEVEL_TWENTY_THREE, PORTFOLIO_RISK_LEVEL_TWENTY_FOUR, PORTFOLIO_RISK_LEVEL_TWENTY_FIVE
sri: boolean
startDate: integer (int64)
state: PortfolioDataState
templatePortfolio: TemplatePortfolio
templatePortfolioActionStatus: string following, period_m, period_q, dist_2_5p, dist_5p, dist_7_5p, dist_10p, paused
wallpaper: Wallpaper
Example
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}

PortfolioDataAdminPatch: object

fee: FieldPatch«FeePatch»
Example
{
  "fee": {
    "action": "string",
    "value": {
      "managementFee": {
        "action": "string",
        "value": "number (double)"
      },
      "safekeepingFee": {
        "action": "string",
        "value": "number (double)"
      }
    }
  }
}

PortfolioDataOwner: object

ownerType: string USER, ORGANIZATION
uuid: string
Example
{
  "ownerType": "string",
  "uuid": "string"
}

PortfolioDataState: object

depositBalance: Decimal
depositTriggers: DepositTrigger
DepositTrigger
feeWithdrawalBalance: Decimal
fullWithdrawal: boolean
hasError: boolean
pendingDeposit: boolean
pendingFeeWithdrawal: boolean
pendingRealloc: boolean
pendingTrade: boolean
pendingWithdrawal: boolean
reallocTriggerType: string NONE, UNKNOWN, ADMIN_MANUAL, MANUAL_TEMPLATE_ASSIGNMENT_UPDATE, MANUAL_TEMPLATE_UPDATE, MANUAL_TRIGGER, TEMPLATE_ASSIGNMENT_UPDATE, TEMPLATE_UPDATE, INTERNAL_TRANSFER, ASSET_REPLACEMENT, PERIODIC_TRIGGER_M, PERIODIC_TRIGGER_Q, DISTRIBUTION_DIFF_TRIGGER_2_5P, DISTRIBUTION_DIFF_TRIGGER_5P, DISTRIBUTION_DIFF_TRIGGER_7_5P, DISTRIBUTION_DIFF_TRIGGER_10P
tradeGroupIdentifier: string
tradeSubState: string PENDING_SELL, SELLING, PENDING_BUY, BUYING, IDLE
withdrawalBalance: Decimal
Example
{
  "depositBalance": "number (double)",
  "depositTriggers": [
    {
      "amount": "number (double)",
      "recurring": "boolean",
      "sourceId": "string",
      "triggerType": "string"
    }
  ],
  "feeWithdrawalBalance": "number (double)",
  "fullWithdrawal": "boolean",
  "hasError": "boolean",
  "pendingDeposit": "boolean",
  "pendingFeeWithdrawal": "boolean",
  "pendingRealloc": "boolean",
  "pendingTrade": "boolean",
  "pendingWithdrawal": "boolean",
  "reallocTriggerType": "string",
  "tradeGroupIdentifier": "string",
  "tradeSubState": "string",
  "withdrawalBalance": "number (double)"
}

PortfolioDataWithOwner: object

accountType: string isk, isk_limited_tax, entity_depot, pension_insurance, isk_track, entity_depot_track
assets: PortfolioPart
PortfolioPart
bearLoss: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
deleted: boolean
endDate: integer (int64)
errors: string[]
string
fee: Fee
feeDiscounts: FeeDiscount
FeeDiscount
goalAmount: Decimal
id: string
initialDeposit: Decimal
investmentPurpose: string BUFFER, RETIREMENT, GENERAL, CHILD_SAVINGS, OTHER
investmentStrategyType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
lastUpdate: integer (int64)
monthlyDeposit: Decimal
monthlyPayout: Decimal
name: string
owner: PortfolioDataOwner
ownerId: string
parent: boolean
parentId: string
payoutEndDate: integer (int64)
portfolioIndex: integer (int32)
riskLevel: string PORTFOLIO_RISK_LEVEL_FOUR, PORTFOLIO_RISK_LEVEL_FIVE, PORTFOLIO_RISK_LEVEL_SIX, PORTFOLIO_RISK_LEVEL_SEVEN, PORTFOLIO_RISK_LEVEL_EIGHT, PORTFOLIO_RISK_LEVEL_NINE, PORTFOLIO_RISK_LEVEL_TEN, PORTFOLIO_RISK_LEVEL_ELEVEN, PORTFOLIO_RISK_LEVEL_TWELVE, PORTFOLIO_RISK_LEVEL_THIRTEEN, PORTFOLIO_RISK_LEVEL_FOURTEEN, PORTFOLIO_RISK_LEVEL_FIFTEEN, PORTFOLIO_RISK_LEVEL_SIXTEEN, PORTFOLIO_RISK_LEVEL_SEVENTEEN, PORTFOLIO_RISK_LEVEL_EIGHTEEN, PORTFOLIO_RISK_LEVEL_NINETEEN, PORTFOLIO_RISK_LEVEL_TWENTY, PORTFOLIO_RISK_LEVEL_TWENTY_ONE, PORTFOLIO_RISK_LEVEL_TWENTY_TWO, PORTFOLIO_RISK_LEVEL_TWENTY_THREE, PORTFOLIO_RISK_LEVEL_TWENTY_FOUR, PORTFOLIO_RISK_LEVEL_TWENTY_FIVE
sri: boolean
startDate: integer (int64)
state: PortfolioDataState
templatePortfolio: TemplatePortfolio
templatePortfolioActionStatus: string following, period_m, period_q, dist_2_5p, dist_5p, dist_7_5p, dist_10p, paused
wallpaper: Wallpaper
Example
{
  "accountType": "string",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string"
    }
  ],
  "bearLoss": "string",
  "deleted": "boolean",
  "endDate": "integer (int64)",
  "errors": [
    "string"
  ],
  "fee": {
    "fixedTradeFee": {
      "exchangeFee": "number (double)",
      "tradeFee": "number (double)"
    },
    "managementFee": "number (double)",
    "noValueBasedDiscount": "boolean",
    "safekeepingFee": "number (double)",
    "tradeFeesNotIncluded": "boolean",
    "valueBasedDiscount": "number (double)",
    "vat": "number (double)"
  },
  "feeDiscounts": [
    {
      "canceled": "string",
      "created": "string",
      "fee": {
        "fixedTradeFee": {
          "exchangeFee": "number (double)",
          "tradeFee": "number (double)"
        },
        "managementFee": "number (double)",
        "noValueBasedDiscount": "boolean",
        "safekeepingFee": "number (double)",
        "tradeFeesNotIncluded": "boolean",
        "valueBasedDiscount": "number (double)",
        "vat": "number (double)"
      },
      "id": "string",
      "periodEnd": "string",
      "periodStart": "string"
    }
  ],
  "goalAmount": "number (double)",
  "id": "string",
  "initialDeposit": "number (double)",
  "investmentPurpose": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "integer (int64)",
  "monthlyDeposit": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "owner": {
    "ownerType": "string",
    "uuid": "string"
  },
  "ownerId": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "integer (int64)",
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "sri": "boolean",
  "startDate": "integer (int64)",
  "state": {
    "depositBalance": "number (double)",
    "depositTriggers": [
      {
        "amount": "number (double)",
        "recurring": "boolean",
        "sourceId": "string",
        "triggerType": "string"
      }
    ],
    "feeWithdrawalBalance": "number (double)",
    "fullWithdrawal": "boolean",
    "hasError": "boolean",
    "pendingDeposit": "boolean",
    "pendingFeeWithdrawal": "boolean",
    "pendingRealloc": "boolean",
    "pendingTrade": "boolean",
    "pendingWithdrawal": "boolean",
    "reallocTriggerType": "string",
    "tradeGroupIdentifier": "string",
    "tradeSubState": "string",
    "withdrawalBalance": "number (double)"
  },
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "templatePortfolioActionStatus": "string",
  "wallpaper": {
    "id": "string",
    "protocol": "string"
  }
}

PortfolioListItem: object

accountType: string isk, isk_limited_tax, entity_depot, pension_insurance, isk_track, entity_depot_track
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
deleted: boolean
endDate: DateRepresentation
investmentStrategyType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
lastUpdate: DateTimeRepresentation
name: string
owner: PortfolioListItemOwner
portfolioIndex: integer (int32)
riskLevel: string PORTFOLIO_RISK_LEVEL_FOUR, PORTFOLIO_RISK_LEVEL_FIVE, PORTFOLIO_RISK_LEVEL_SIX, PORTFOLIO_RISK_LEVEL_SEVEN, PORTFOLIO_RISK_LEVEL_EIGHT, PORTFOLIO_RISK_LEVEL_NINE, PORTFOLIO_RISK_LEVEL_TEN, PORTFOLIO_RISK_LEVEL_ELEVEN, PORTFOLIO_RISK_LEVEL_TWELVE, PORTFOLIO_RISK_LEVEL_THIRTEEN, PORTFOLIO_RISK_LEVEL_FOURTEEN, PORTFOLIO_RISK_LEVEL_FIFTEEN, PORTFOLIO_RISK_LEVEL_SIXTEEN, PORTFOLIO_RISK_LEVEL_SEVENTEEN, PORTFOLIO_RISK_LEVEL_EIGHTEEN, PORTFOLIO_RISK_LEVEL_NINETEEN, PORTFOLIO_RISK_LEVEL_TWENTY, PORTFOLIO_RISK_LEVEL_TWENTY_ONE, PORTFOLIO_RISK_LEVEL_TWENTY_TWO, PORTFOLIO_RISK_LEVEL_TWENTY_THREE, PORTFOLIO_RISK_LEVEL_TWENTY_FOUR, PORTFOLIO_RISK_LEVEL_TWENTY_FIVE
startDate: DateRepresentation
templatePortfolio: TemplatePortfolio
uuid: string
value: PortfolioValue
Example
{
  "accountType": "string",
  "clientId": "string",
  "deleted": "boolean",
  "endDate": "string",
  "investmentStrategyType": "string",
  "lastUpdate": "string",
  "name": "string",
  "owner": {
    "identifier": "integer (int64)",
    "name": "string",
    "ownerType": "string",
    "uuid": "string"
  },
  "portfolioIndex": "integer (int32)",
  "riskLevel": "string",
  "startDate": "string",
  "templatePortfolio": {
    "distribution": [
      {
        "asset": {
          "activeManagement": "boolean",
          "added": "string",
          "assetClass": "string",
          "aum": "number (double)",
          "aumCurrency": "string",
          "aumDate": "string",
          "baseValue": {
            "lastClosing": "number (double)",
            "lastClosingDate": "string"
          },
          "benchmarkName": "string",
          "categorySwe": "string",
          "ceo": "string",
          "commentsSwe": "string",
          "country": "string",
          "currency": "string",
          "currencyAllocation": "object",
          "currencyAllocationDate": "string",
          "currencyExchangeFeeDisabled": "boolean",
          "currencyHedged": "boolean",
          "dataSourceExchangeCode": "string",
          "descriptionSwe": "string",
          "dividendCurrency": "string",
          "dividendFrequency": "string",
          "dividendYield": "number (double)",
          "exchangeCode": "string",
          "geoAllocation": "object",
          "geoAllocationDate": "string",
          "geography": "string",
          "holdingsAllocation": "object",
          "holdingsAllocationDate": "string",
          "id": "string",
          "inceptionDate": "string",
          "index": "integer (int32)",
          "isActiveModel": "boolean",
          "isActivePlatform": "boolean",
          "isCollectingData": "boolean",
          "isTradeStopped": "boolean",
          "isin": "string",
          "issuingCompany": "string",
          "kiidUrl": "string",
          "market": "string",
          "metricBeta": "number (double)",
          "metricPe": "number (double)",
          "metricPs": "number (double)",
          "msciEsgDataDate": "string",
          "msciEsgDataPresent": "boolean",
          "msciEsgQualityScore": "number (double)",
          "msciEsgQualityScorePctlGlobal": "number (double)",
          "msciEsgQualityScorePctlPeer": "number (double)",
          "msciEsgRating": "string",
          "msciSustainableImpactPct": "number (double)",
          "msciWaCO2i": "number (double)",
          "name": "string",
          "notes": "string",
          "numEmployees": "integer (int32)",
          "numberOfHoldings": "integer (int32)",
          "numberOfHoldingsDate": "string",
          "orderRoute": "string",
          "replicationStrategy": "string",
          "riskFactor": "string",
          "riskLevel": "integer (int32)",
          "sectors": [
            "string"
          ],
          "sharesTotal": "integer (int32)",
          "shortName": "string",
          "simpleId": "integer (int64)",
          "sri": "boolean",
          "strategyDescriptionSwe": "string",
          "tags": [
            "string"
          ],
          "ter": "number (double)",
          "ticker": "string",
          "tradeFeeDisabled": "boolean",
          "type": "string",
          "ucits": "boolean",
          "url": "string",
          "value": {
            "buy": "number (double)",
            "currency": "string",
            "currencyExchangeRate": "number (double)",
            "fiveYears": "number (double)",
            "last": "number (double)",
            "lastClosing": "number (double)",
            "lastClosingDate": "string",
            "lastPeriodUpdate": "string",
            "lastValueUpdated": "string",
            "oneMonth": "number (double)",
            "oneYear": "number (double)",
            "sell": "number (double)",
            "sixMonths": "number (double)",
            "thisYear": "number (double)",
            "threeMonths": "number (double)",
            "threeYears": "number (double)"
          }
        },
        "fraction": "number (double)"
      }
    ],
    "estimatedReturn": "number (double)",
    "id": "string",
    "lastDistributionChange": "integer (int64)",
    "lastDistributionRefresh": "integer (int64)",
    "maxDD": "number (double)",
    "name": "string",
    "strategyIndex": "string",
    "targetDistribution": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    },
    "targetVar": "number (double)",
    "trackingPortfolio": "string",
    "type": "string",
    "var": "number (double)",
    "volatility": "number (double)"
  },
  "uuid": "string",
  "value": {
    "historicalReturn": "number (double)",
    "returnCurrentQuarter": "number (double)",
    "returnCurrentYear": "number (double)",
    "returnValue": "number (double)",
    "returnValueLatestMonth": "number (double)",
    "returnValueLatestYear": "number (double)",
    "totalEarnings": "number (double)",
    "totalInvested": "number (double)",
    "totalValue": "number (double)",
    "totalWithdrawn": "number (double)",
    "updated": "string"
  }
}

PortfolioListItemOwner: object

identifier: integer (int64)
name: string
ownerType: string USER, ORGANIZATION
uuid: string
Example
{
  "identifier": "integer (int64)",
  "name": "string",
  "ownerType": "string",
  "uuid": "string"
}

PortfolioLogEntry: object

ownerId: string
payload: PortfolioLogEntryPayload
portfolioId: string
portfolioLogEntryType: string PORTFOLIO_CREATED, PORTFOLIO_DEPOSIT, PORTFOLIO_INTERNAL_TRANSFER, PORTFOLIO_DEPOSIT_MONOPOLY, PORTFOLIO_EXTERNAL_TRANSFER, PORTFOLIO_DIVIDEND_TRANSFER, PORTFOLIO_INIT_WITHDRAWAL, PORTFOLIO_INIT_TRANSACTION, PORTFOLIO_CASH_TRANSACTION, PORTFOLIO_QUEUE_REALLOC, PORTFOLIO_TRADE_ESTIMATE, PORTFOLIO_TRADE_COMPLETED, PORTFOLIO_TRADE_SETTLED, PORTFOLIO_TRADE_CANCELLATION, PORTFOLIO_CASH_RESERVATION, PORTFOLIO_TEMPLATE_ASSIGNMENT, PORTFOLIO_UPDATE, PORTFOLIO_ADMIN_UPDATE, PORTFOLIO_STRATEGY_UPDATE, PORTFOLIO_SET_ERROR, PORTFOLIO_TRADE_ORDER_CANCELLED, PORTFOLIO_TRADE_ORDER_RECURRING_UP, PORTFOLIO_FEE_DEDUCTED, PORTFOLIO_FEE_TRANSFERRED, PORTFOLIO_FEE_ADJUSTED, PORTFOLIO_ISK_REPORT, PORTFOLIO_ISK_REPORT_2022, PORTFOLIO_ISK_REPORT_2023, PORTFOLIO_DISCOUNT_ADDED, PORTFOLIO_DISCOUNT_CANCELED, PORTFOLIO_DELETED, ASSET_UPDATE, ASSET_DIVIDEND, PORTFOLIO_REFERRAL_PAYOUT, USER_MIGRATION
timestamp: integer (int64)
type: string
userId: string
uuid: string
Example
{
  "ownerId": "string",
  "payload": "object",
  "portfolioId": "string",
  "portfolioLogEntryType": "string",
  "timestamp": "integer (int64)",
  "type": "string",
  "userId": "string",
  "uuid": "string"
}

PortfolioLogEntryPayload: object

Example
"object"

PortfolioOwner: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
customerType: string USER, ORGANIZATION
legalIdentifierAsLong: integer (int64)
name: string
simpleId: integer (int64)
uuid: string
Example
{
  "clientId": "string",
  "customerType": "string",
  "legalIdentifierAsLong": "integer (int64)",
  "name": "string",
  "simpleId": "integer (int64)",
  "uuid": "string"
}

PortfolioPart: object

amount: Decimal
assetId: string
Example
{
  "amount": "number (double)",
  "assetId": "string"
}

PortfolioPartDiffRepresentation: object

amount: Decimal
assetId: string
expectedAmount: Decimal
lastSavedAmount: Decimal
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "expectedAmount": "number (double)",
  "lastSavedAmount": "number (double)"
}

PortfolioTradeOrder: object

amount: Decimal
assets: PortfolioTradeOrderItem
PortfolioTradeOrderItem
created: DateTimeRepresentation
currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
id: string
marketOrderId: string
orderEstimates: OrderEstimateItem
OrderEstimateItem
orderState: string transfer_pending, transferring, transfer_error, pending, settling, completed, error, canceled, recurring, recurring_paused, recurring_canceled, recurring_error
ownerId: string
portfolioId: string
recurringSource: string
simpleId: integer (int32)
sourceId: string
sourceType: string portfolio, bank_account, bank_account_ag, swish, monopoly, void
targetId: string
targetType: string portfolio, bank_account, bank_account_ag, swish, monopoly, void
tradeGroupId: string
tradeId: string
transactionDay: integer (int32)
type: string buy, sell, sell_all, dividend, payout
Example
{
  "amount": "number (double)",
  "assets": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "tradeUnit": "string",
      "value": "number (double)"
    }
  ],
  "created": "string",
  "currency": "string",
  "id": "string",
  "marketOrderId": "string",
  "orderEstimates": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "currencyExchangeFee": "number (double)",
      "currencyExchangeRate": {
        "price": "number (double)",
        "timestamp": "string"
      },
      "price": {
        "price": "number (double)",
        "timestamp": "string"
      },
      "tradeFee": "number (double)",
      "type": "string",
      "value": "number (double)"
    }
  ],
  "orderState": "string",
  "ownerId": "string",
  "portfolioId": "string",
  "recurringSource": "string",
  "simpleId": "integer (int32)",
  "sourceId": "string",
  "sourceType": "string",
  "targetId": "string",
  "targetType": "string",
  "tradeGroupId": "string",
  "tradeId": "string",
  "transactionDay": "integer (int32)",
  "type": "string"
}

PortfolioTradeOrderFilter: object

assetId: string
maxDate: DateRepresentation
minDate: DateRepresentation
orderState: string[]
string transfer_pending, transferring, transfer_error, pending, settling, completed, error, canceled, recurring, recurring_paused, recurring_canceled, recurring_error
orderType: string buy, sell, sell_all, dividend, payout
portfolioType: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
recurring: string include, exclude
source: string
sourceType: string portfolio, bank_account, bank_account_ag, swish, monopoly, void
target: string
targetType: string portfolio, bank_account, bank_account_ag, swish, monopoly, void
Example
{
  "assetId": "string",
  "maxDate": "string",
  "minDate": "string",
  "orderState": [
    "string"
  ],
  "orderType": "string",
  "portfolioType": "string",
  "recurring": "string",
  "source": "string",
  "sourceType": "string",
  "target": "string",
  "targetType": "string"
}

PortfolioTradeOrderItem: object

amount: Decimal
assetId: string
tradeUnit: string VALUE, SHARES
value: Decimal
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "tradeUnit": "string",
  "value": "number (double)"
}

PortfolioValue: object

historicalReturn: Decimal
returnCurrentQuarter: Decimal
returnCurrentYear: Decimal
returnValue: Decimal
returnValueLatestMonth: Decimal
returnValueLatestYear: Decimal
totalEarnings: Decimal
totalInvested: Decimal
totalValue: Decimal
totalWithdrawn: Decimal
updated: DateTimeRepresentation
Example
{
  "historicalReturn": "number (double)",
  "returnCurrentQuarter": "number (double)",
  "returnCurrentYear": "number (double)",
  "returnValue": "number (double)",
  "returnValueLatestMonth": "number (double)",
  "returnValueLatestYear": "number (double)",
  "totalEarnings": "number (double)",
  "totalInvested": "number (double)",
  "totalValue": "number (double)",
  "totalWithdrawn": "number (double)",
  "updated": "string"
}

PortfolioValueSource: object

templateId: string
templateOwnerId: string
Example
{
  "templateId": "string",
  "templateOwnerId": "string"
}

PortfolioValueWithReservations: object

historicalReturn: Decimal
reservations: CashReservations
reservedAmount: Decimal
returnCurrentQuarter: Decimal
returnCurrentYear: Decimal
returnValue: Decimal
returnValueLatestMonth: Decimal
returnValueLatestYear: Decimal
totalEarnings: Decimal
totalInvested: Decimal
totalValue: Decimal
totalWithdrawn: Decimal
updated: DateTimeRepresentation
Example
{
  "historicalReturn": "number (double)",
  "reservations": {
    "feeAmount": "number (double)",
    "settlementAmount": "number (double)",
    "totalAmount": "number (double)",
    "withdrawalAmount": "number (double)"
  },
  "reservedAmount": "number (double)",
  "returnCurrentQuarter": "number (double)",
  "returnCurrentYear": "number (double)",
  "returnValue": "number (double)",
  "returnValueLatestMonth": "number (double)",
  "returnValueLatestYear": "number (double)",
  "totalEarnings": "number (double)",
  "totalInvested": "number (double)",
  "totalValue": "number (double)",
  "totalWithdrawn": "number (double)",
  "updated": "string"
}

PortfoliosLogFilter: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
maxTimestamp: DateTimeRepresentation
minTimestamp: DateTimeRepresentation
portfolioId: string
sourceCode: string
templatePortfolioIds: string[]
string
types: string[]
string PORTFOLIO_CREATED, PORTFOLIO_DEPOSIT, PORTFOLIO_INTERNAL_TRANSFER, PORTFOLIO_DEPOSIT_MONOPOLY, PORTFOLIO_EXTERNAL_TRANSFER, PORTFOLIO_DIVIDEND_TRANSFER, PORTFOLIO_INIT_WITHDRAWAL, PORTFOLIO_INIT_TRANSACTION, PORTFOLIO_CASH_TRANSACTION, PORTFOLIO_QUEUE_REALLOC, PORTFOLIO_TRADE_ESTIMATE, PORTFOLIO_TRADE_COMPLETED, PORTFOLIO_TRADE_SETTLED, PORTFOLIO_TRADE_CANCELLATION, PORTFOLIO_CASH_RESERVATION, PORTFOLIO_TEMPLATE_ASSIGNMENT, PORTFOLIO_UPDATE, PORTFOLIO_ADMIN_UPDATE, PORTFOLIO_STRATEGY_UPDATE, PORTFOLIO_SET_ERROR, PORTFOLIO_TRADE_ORDER_CANCELLED, PORTFOLIO_TRADE_ORDER_RECURRING_UP, PORTFOLIO_FEE_DEDUCTED, PORTFOLIO_FEE_TRANSFERRED, PORTFOLIO_FEE_ADJUSTED, PORTFOLIO_ISK_REPORT, PORTFOLIO_ISK_REPORT_2022, PORTFOLIO_ISK_REPORT_2023, PORTFOLIO_DISCOUNT_ADDED, PORTFOLIO_DISCOUNT_CANCELED, PORTFOLIO_DELETED, ASSET_UPDATE, ASSET_DIVIDEND, PORTFOLIO_REFERRAL_PAYOUT, USER_MIGRATION
Example
{
  "clientId": "string",
  "maxTimestamp": "string",
  "minTimestamp": "string",
  "portfolioId": "string",
  "sourceCode": "string",
  "templatePortfolioIds": [
    "string"
  ],
  "types": [
    "string"
  ]
}

PriceEstimate: object

price: Decimal
timestamp: DateTimeRepresentation
Example
{
  "price": "number (double)",
  "timestamp": "string"
}

Principal: object

name: string
personalNumber: PersonalNumber
Example
{
  "name": "string",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  }
}

RecurringTransaction: object

amount: Decimal
bankAccountId: string
created: DateTimeRepresentation
paused: boolean
portfolioIndex: integer (int32)
protocol: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
status: string NONE, PENDING, EXPORTED, ACTIVE, ERROR, ERROR_BAD_ACC_TYPE, ERROR_INVALID_ACC, ERROR_INVALID_IDENTIFIER, ERROR_INVALID_BANKACCOUNT_NUMBER, PENDING_CANCEL, CANCELED, PENDING_CANCEL_BY_USER, CANCELED_BY_USER, PENDING_CANCEL_BY_ADMIN, CANCELED_BY_ADMIN, CANCELED_BY_EXTERNAL
transactionDay: integer (int32)
type: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
userUuid: string
uuid: string
Example
{
  "amount": "number (double)",
  "bankAccountId": "string",
  "created": "string",
  "paused": "boolean",
  "portfolioIndex": "integer (int32)",
  "protocol": "string",
  "status": "string",
  "transactionDay": "integer (int32)",
  "type": "string",
  "userUuid": "string",
  "uuid": "string"
}

ReferralPayoutConfiguration: object

depositShare: Decimal
Example
{
  "depositShare": "number (double)"
}

ReferralPayoutPayload: object

payoutAmount: Decimal
payoutLeftover: Decimal
payoutMethod: string cash, invoice
periodEnd: DateRepresentation
periodStart: DateRepresentation
Example
{
  "payoutAmount": "number (double)",
  "payoutLeftover": "number (double)",
  "payoutMethod": "string",
  "periodEnd": "string",
  "periodStart": "string"
}

ReferralPayoutResult: object

logItemId: string
message: string
orderId: string
portfolioId: string
referralPayoutPayload: ReferralPayoutPayload
status: string SUCCESS, FAILED
transactionId: string
Example
{
  "logItemId": "string",
  "message": "string",
  "orderId": "string",
  "portfolioId": "string",
  "referralPayoutPayload": {
    "payoutAmount": "number (double)",
    "payoutLeftover": "number (double)",
    "payoutMethod": "string",
    "periodEnd": "string",
    "periodStart": "string"
  },
  "status": "string",
  "transactionId": "string"
}

ResultItem: object

assetId: string
bankAmount: Decimal
isin: string
successful: boolean
systemAmount: Decimal
Example
{
  "assetId": "string",
  "bankAmount": "number (double)",
  "isin": "string",
  "successful": "boolean",
  "systemAmount": "number (double)"
}

RiskFactor: object

currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
distributing: boolean
id: string
name: string
trackingETF: string
trackingExchange: string
Example
{
  "currency": "string",
  "distributing": "boolean",
  "id": "string",
  "name": "string",
  "trackingETF": "string",
  "trackingExchange": "string"
}

SPARAddressDetails: object

address: string[]
string
addressType: string SWEDISH, ABROAD
careOf: string
country: string
postalAddress: string
postalNumber: string
validFrom: DateTimeRepresentation
validUntil: DateTimeRepresentation
Example
{
  "address": [
    "string"
  ],
  "addressType": "string",
  "careOf": "string",
  "country": "string",
  "postalAddress": "string",
  "postalNumber": "string",
  "validFrom": "string",
  "validUntil": "string"
}

SPARData: object

addressDetails: SPARAddressDetails
SPARAddressDetails
lastUpdate: DateTimeRepresentation
personDetails: SPARPersonDetails
SPARPersonDetails
raw: string
Example
{
  "addressDetails": [
    {
      "address": [
        "string"
      ],
      "addressType": "string",
      "careOf": "string",
      "country": "string",
      "postalAddress": "string",
      "postalNumber": "string",
      "validFrom": "string",
      "validUntil": "string"
    }
  ],
  "lastUpdate": "string",
  "personDetails": [
    {
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "usedName": "integer (int32)",
      "validFrom": "string",
      "validUntil": "string"
    }
  ],
  "raw": "string"
}

SPARPersonDetails: object

firstName: string
lastName: string
middleName: string
usedName: integer (int32)
validFrom: DateTimeRepresentation
validUntil: DateTimeRepresentation
Example
{
  "firstName": "string",
  "lastName": "string",
  "middleName": "string",
  "usedName": "integer (int32)",
  "validFrom": "string",
  "validUntil": "string"
}

SharedCustomTemplate: object

accessibility: string private, public, delisted
created: DateTimeRepresentation
distribution: TemplatePortfolioDistributionPart
TemplatePortfolioDistributionPart
id: string
meta: CustomTemplatePortfolioMeta
ownerId: string
published: DateTimeRepresentation
sharerProfile: UserProfile
ter: Decimal
trackingPortfolioId: string
value: CustomTemplatePortfolioValue
Example
{
  "accessibility": "string",
  "created": "string",
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "id": "string",
  "meta": {
    "assetTypes": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "description": "string",
    "grade": "integer (int32)",
    "name": "string",
    "rank": "integer (int32)",
    "sri": "boolean",
    "status": {
      "level": "string",
      "trigger": "string"
    }
  },
  "ownerId": "string",
  "published": "string",
  "sharerProfile": {
    "alias": "string",
    "description": "string",
    "facebookLink": "string",
    "id": "string",
    "instagramLink": "string",
    "linkedinLink": "string",
    "profilePicture": "string",
    "ticktockLink": "string",
    "topTraderData": {
      "aumFraction": "number (double)",
      "depositFraction": "number (double)",
      "enabled": "boolean",
      "payoutMethod": "string"
    },
    "userUuid": "string",
    "verified": "boolean"
  },
  "ter": "number (double)",
  "trackingPortfolioId": "string",
  "value": {
    "aum": "number (double)",
    "distribution": {
      "alternatives": "integer (int32)",
      "commodities": "integer (int32)",
      "equity": "integer (int32)",
      "fixedIncome": "integer (int32)"
    },
    "fiveYears": "number (double)",
    "followers": "integer (int32)",
    "lastPeriodUpdate": "string",
    "oneMonth": "number (double)",
    "oneYear": "number (double)",
    "sixMonths": "number (double)",
    "thisYear": "number (double)",
    "threeMonths": "number (double)",
    "threeYears": "number (double)"
  }
}

SharedPortfolioStatus: object

level: string not set, green, yellow, red, illegal
trigger: string missing data, num assets, min investment
Example
{
  "level": "string",
  "trigger": "string"
}

SignableGroupId: object

groupId: string
groupType: string SIGN_UP, AUTO_GIRO, ADD_PORTFOLIO, ADD_PENSION_INSURANCE, SIGN_UP_ORG, ADD_ENTITY_DEPOT_PORTFOLIO
major: integer (int32)
minor: integer (int32)
Example
{
  "groupId": "string",
  "groupType": "string",
  "major": "integer (int32)",
  "minor": "integer (int32)"
}

SuspiciousTransaction: object

created: DateTimeRepresentation
id: string
status: string OPEN, RESOLVED
type: string GENERIC, MULTIPLE_TRANSACTIONS, LARGE_TRANSACTION, QUICK_WITHDRAWAL
userId: string
Example
{
  "created": "string",
  "id": "string",
  "status": "string",
  "type": "string",
  "userId": "string"
}

SuspiciousTransactionPatch: object

status: FieldPatch«string»
Example
{
  "status": {
    "action": "string",
    "value": "string"
  }
}

SwedishPersonalNumber: string

Personal number in the format se-YYYYNNDDXXXX

SwishTransaction: object

portfolio: PortfolioData
transaction: Transaction
user: User
Example
{
  "portfolio": {
    "accountType": "string",
    "assets": [
      {
        "amount": "number (double)",
        "assetId": "string"
      }
    ],
    "bearLoss": "string",
    "deleted": "boolean",
    "endDate": "integer (int64)",
    "errors": [
      "string"
    ],
    "fee": {
      "fixedTradeFee": {
        "exchangeFee": "number (double)",
        "tradeFee": "number (double)"
      },
      "managementFee": "number (double)",
      "noValueBasedDiscount": "boolean",
      "safekeepingFee": "number (double)",
      "tradeFeesNotIncluded": "boolean",
      "valueBasedDiscount": "number (double)",
      "vat": "number (double)"
    },
    "feeDiscounts": [
      {
        "canceled": "string",
        "created": "string",
        "fee": {
          "fixedTradeFee": {
            "exchangeFee": "number (double)",
            "tradeFee": "number (double)"
          },
          "managementFee": "number (double)",
          "noValueBasedDiscount": "boolean",
          "safekeepingFee": "number (double)",
          "tradeFeesNotIncluded": "boolean",
          "valueBasedDiscount": "number (double)",
          "vat": "number (double)"
        },
        "id": "string",
        "periodEnd": "string",
        "periodStart": "string"
      }
    ],
    "goalAmount": "number (double)",
    "id": "string",
    "initialDeposit": "number (double)",
    "investmentPurpose": "string",
    "investmentStrategyType": "string",
    "lastUpdate": "integer (int64)",
    "monthlyDeposit": "number (double)",
    "monthlyPayout": "number (double)",
    "name": "string",
    "ownerId": "string",
    "parent": "boolean",
    "parentId": "string",
    "payoutEndDate": "integer (int64)",
    "portfolioIndex": "integer (int32)",
    "riskLevel": "string",
    "sri": "boolean",
    "startDate": "integer (int64)",
    "state": {
      "depositBalance": "number (double)",
      "depositTriggers": [
        {
          "amount": "number (double)",
          "recurring": "boolean",
          "sourceId": "string",
          "triggerType": "string"
        }
      ],
      "feeWithdrawalBalance": "number (double)",
      "fullWithdrawal": "boolean",
      "hasError": "boolean",
      "pendingDeposit": "boolean",
      "pendingFeeWithdrawal": "boolean",
      "pendingRealloc": "boolean",
      "pendingTrade": "boolean",
      "pendingWithdrawal": "boolean",
      "reallocTriggerType": "string",
      "tradeGroupIdentifier": "string",
      "tradeSubState": "string",
      "withdrawalBalance": "number (double)"
    },
    "templatePortfolio": {
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "estimatedReturn": "number (double)",
      "id": "string",
      "lastDistributionChange": "integer (int64)",
      "lastDistributionRefresh": "integer (int64)",
      "maxDD": "number (double)",
      "name": "string",
      "strategyIndex": "string",
      "targetDistribution": {
        "alternative": "number (double)",
        "bonds": "number (double)",
        "commodities": "number (double)",
        "stocks": "number (double)"
      },
      "targetVar": "number (double)",
      "trackingPortfolio": "string",
      "type": "string",
      "var": "number (double)",
      "volatility": "number (double)"
    },
    "templatePortfolioActionStatus": "string",
    "wallpaper": {
      "id": "string",
      "protocol": "string"
    }
  },
  "transaction": {
    "amount": "number (double)",
    "bulkUuid": "string",
    "created": "integer (int64)",
    "errorMessage": "string",
    "externalId": "string",
    "initiated": "integer (int64)",
    "internalId": "string",
    "owner": {
      "clientId": "string",
      "customerType": "string",
      "legalIdentifierAsLong": "integer (int64)",
      "name": "string",
      "simpleId": "integer (int64)",
      "uuid": "string"
    },
    "portfolioUuid": "string",
    "protocol": "string",
    "recurringTransactionDate": "string",
    "recurringTransactionId": "string",
    "status": "string",
    "subTransactions": [
      "#/definitions/Transaction"
    ],
    "targetAccount": {
      "accountNumber": "string",
      "autogiroPayerId": "integer (int64)",
      "autogiroStatus": "string",
      "bankIdentifier": "string",
      "clearingNumber": "string",
      "created": "string",
      "name": "string",
      "primary": "boolean",
      "signature": "string",
      "userUuid": "string",
      "uuid": "string"
    },
    "type": "string",
    "updated": "integer (int64)",
    "userUuid": "string",
    "uuid": "string"
  },
  "user": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}

SwishTransactionUpdate: object

bankTransactionIdentifier: string
message: string
paymentRequestToken: string
status: string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
Example
{
  "bankTransactionIdentifier": "string",
  "message": "string",
  "paymentRequestToken": "string",
  "status": "string"
}

TargetDistribution: object

alternative: Decimal
bonds: Decimal
commodities: Decimal
stocks: Decimal
Example
{
  "alternative": "number (double)",
  "bonds": "number (double)",
  "commodities": "number (double)",
  "stocks": "number (double)"
}

TaxReportContactPerson: object

email: string
name: string
phone: string
Example
{
  "email": "string",
  "name": "string",
  "phone": "string"
}

TaxReportMeta: object

contactPerson: TaxReportContactPerson
organisationNumber: string
techContactPerson: TaxReportContactPerson
Example
{
  "contactPerson": {
    "email": "string",
    "name": "string",
    "phone": "string"
  },
  "organisationNumber": "string",
  "techContactPerson": {
    "email": "string",
    "name": "string",
    "phone": "string"
  }
}

TemplateContent: object

Example
"object"

TemplatePortfolio: object

distribution: TemplatePortfolioDistributionPart
TemplatePortfolioDistributionPart
estimatedReturn: Decimal
id: string
lastDistributionChange: integer (int64)
lastDistributionRefresh: integer (int64)
maxDD: Decimal
name: string
strategyIndex: string VAR_ONE, VAR_TWO, VAR_THREE, VAR_FOUR, VAR_FIVE, VAR_SIX, VAR_SEVEN, BUFFER_ONE, VAR_ONE_SRI, VAR_TWO_SRI, VAR_THREE_SRI, VAR_FOUR_SRI, VAR_FIVE_SRI, VAR_SIX_SRI, VAR_SEVEN_SRI, BUFFER_ONE_SRI, STATIC_1, STATIC_2, STATIC_3, STATIC_4, STATIC_5, STATIC_6, STATIC_7, STATIC_1_SRI, STATIC_2_SRI, STATIC_3_SRI, STATIC_4_SRI, STATIC_5_SRI, STATIC_6_SRI, STATIC_7_SRI, PENSION_SFB_1, PENSION_SFB_2, PENSION_SFB_3, STATIC_15_85, STATIC_30_70, STATIC_50_50, STATIC_70_30, STATIC_85_15
targetDistribution: TargetDistribution
targetVar: Decimal
trackingPortfolio: string
type: string REBALANCING_TEMPLATE_PORTFOLIO, REOPTIMIZING_TEMPLATE_PORTFOLIO, EXTERNAL_TEMPLATE_PORTFOLIO
var: Decimal
volatility: Decimal
Example
{
  "distribution": [
    {
      "asset": {
        "activeManagement": "boolean",
        "added": "string",
        "assetClass": "string",
        "aum": "number (double)",
        "aumCurrency": "string",
        "aumDate": "string",
        "baseValue": {
          "lastClosing": "number (double)",
          "lastClosingDate": "string"
        },
        "benchmarkName": "string",
        "categorySwe": "string",
        "ceo": "string",
        "commentsSwe": "string",
        "country": "string",
        "currency": "string",
        "currencyAllocation": "object",
        "currencyAllocationDate": "string",
        "currencyExchangeFeeDisabled": "boolean",
        "currencyHedged": "boolean",
        "dataSourceExchangeCode": "string",
        "descriptionSwe": "string",
        "dividendCurrency": "string",
        "dividendFrequency": "string",
        "dividendYield": "number (double)",
        "exchangeCode": "string",
        "geoAllocation": "object",
        "geoAllocationDate": "string",
        "geography": "string",
        "holdingsAllocation": "object",
        "holdingsAllocationDate": "string",
        "id": "string",
        "inceptionDate": "string",
        "index": "integer (int32)",
        "isActiveModel": "boolean",
        "isActivePlatform": "boolean",
        "isCollectingData": "boolean",
        "isTradeStopped": "boolean",
        "isin": "string",
        "issuingCompany": "string",
        "kiidUrl": "string",
        "market": "string",
        "metricBeta": "number (double)",
        "metricPe": "number (double)",
        "metricPs": "number (double)",
        "msciEsgDataDate": "string",
        "msciEsgDataPresent": "boolean",
        "msciEsgQualityScore": "number (double)",
        "msciEsgQualityScorePctlGlobal": "number (double)",
        "msciEsgQualityScorePctlPeer": "number (double)",
        "msciEsgRating": "string",
        "msciSustainableImpactPct": "number (double)",
        "msciWaCO2i": "number (double)",
        "name": "string",
        "notes": "string",
        "numEmployees": "integer (int32)",
        "numberOfHoldings": "integer (int32)",
        "numberOfHoldingsDate": "string",
        "orderRoute": "string",
        "replicationStrategy": "string",
        "riskFactor": "string",
        "riskLevel": "integer (int32)",
        "sectors": [
          "string"
        ],
        "sharesTotal": "integer (int32)",
        "shortName": "string",
        "simpleId": "integer (int64)",
        "sri": "boolean",
        "strategyDescriptionSwe": "string",
        "tags": [
          "string"
        ],
        "ter": "number (double)",
        "ticker": "string",
        "tradeFeeDisabled": "boolean",
        "type": "string",
        "ucits": "boolean",
        "url": "string",
        "value": {
          "buy": "number (double)",
          "currency": "string",
          "currencyExchangeRate": "number (double)",
          "fiveYears": "number (double)",
          "last": "number (double)",
          "lastClosing": "number (double)",
          "lastClosingDate": "string",
          "lastPeriodUpdate": "string",
          "lastValueUpdated": "string",
          "oneMonth": "number (double)",
          "oneYear": "number (double)",
          "sell": "number (double)",
          "sixMonths": "number (double)",
          "thisYear": "number (double)",
          "threeMonths": "number (double)",
          "threeYears": "number (double)"
        }
      },
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "id": "string",
  "lastDistributionChange": "integer (int64)",
  "lastDistributionRefresh": "integer (int64)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "trackingPortfolio": "string",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}

TemplatePortfolioCreateData: object

distribution: TemplatePortfolioPart
TemplatePortfolioPart
estimatedReturn: Decimal
maxDD: Decimal
name: string
strategyIndex: string VAR_ONE, VAR_TWO, VAR_THREE, VAR_FOUR, VAR_FIVE, VAR_SIX, VAR_SEVEN, BUFFER_ONE, VAR_ONE_SRI, VAR_TWO_SRI, VAR_THREE_SRI, VAR_FOUR_SRI, VAR_FIVE_SRI, VAR_SIX_SRI, VAR_SEVEN_SRI, BUFFER_ONE_SRI, STATIC_1, STATIC_2, STATIC_3, STATIC_4, STATIC_5, STATIC_6, STATIC_7, STATIC_1_SRI, STATIC_2_SRI, STATIC_3_SRI, STATIC_4_SRI, STATIC_5_SRI, STATIC_6_SRI, STATIC_7_SRI, PENSION_SFB_1, PENSION_SFB_2, PENSION_SFB_3, STATIC_15_85, STATIC_30_70, STATIC_50_50, STATIC_70_30, STATIC_85_15
targetDistribution: TargetDistribution
targetVar: Decimal
type: string REBALANCING_TEMPLATE_PORTFOLIO, REOPTIMIZING_TEMPLATE_PORTFOLIO, EXTERNAL_TEMPLATE_PORTFOLIO
var: Decimal
volatility: Decimal
Example
{
  "distribution": [
    {
      "assetId": "string",
      "fraction": "number (double)"
    }
  ],
  "estimatedReturn": "number (double)",
  "maxDD": "number (double)",
  "name": "string",
  "strategyIndex": "string",
  "targetDistribution": {
    "alternative": "number (double)",
    "bonds": "number (double)",
    "commodities": "number (double)",
    "stocks": "number (double)"
  },
  "targetVar": "number (double)",
  "type": "string",
  "var": "number (double)",
  "volatility": "number (double)"
}

TemplatePortfolioDistributionPart: object

asset: Asset
fraction: Decimal
Example
{
  "asset": {
    "activeManagement": "boolean",
    "added": "string",
    "assetClass": "string",
    "aum": "number (double)",
    "aumCurrency": "string",
    "aumDate": "string",
    "baseValue": {
      "lastClosing": "number (double)",
      "lastClosingDate": "string"
    },
    "benchmarkName": "string",
    "categorySwe": "string",
    "ceo": "string",
    "commentsSwe": "string",
    "country": "string",
    "currency": "string",
    "currencyAllocation": "object",
    "currencyAllocationDate": "string",
    "currencyExchangeFeeDisabled": "boolean",
    "currencyHedged": "boolean",
    "dataSourceExchangeCode": "string",
    "descriptionSwe": "string",
    "dividendCurrency": "string",
    "dividendFrequency": "string",
    "dividendYield": "number (double)",
    "exchangeCode": "string",
    "geoAllocation": "object",
    "geoAllocationDate": "string",
    "geography": "string",
    "holdingsAllocation": "object",
    "holdingsAllocationDate": "string",
    "id": "string",
    "inceptionDate": "string",
    "index": "integer (int32)",
    "isActiveModel": "boolean",
    "isActivePlatform": "boolean",
    "isCollectingData": "boolean",
    "isTradeStopped": "boolean",
    "isin": "string",
    "issuingCompany": "string",
    "kiidUrl": "string",
    "market": "string",
    "metricBeta": "number (double)",
    "metricPe": "number (double)",
    "metricPs": "number (double)",
    "msciEsgDataDate": "string",
    "msciEsgDataPresent": "boolean",
    "msciEsgQualityScore": "number (double)",
    "msciEsgQualityScorePctlGlobal": "number (double)",
    "msciEsgQualityScorePctlPeer": "number (double)",
    "msciEsgRating": "string",
    "msciSustainableImpactPct": "number (double)",
    "msciWaCO2i": "number (double)",
    "name": "string",
    "notes": "string",
    "numEmployees": "integer (int32)",
    "numberOfHoldings": "integer (int32)",
    "numberOfHoldingsDate": "string",
    "orderRoute": "string",
    "replicationStrategy": "string",
    "riskFactor": "string",
    "riskLevel": "integer (int32)",
    "sectors": [
      "string"
    ],
    "sharesTotal": "integer (int32)",
    "shortName": "string",
    "simpleId": "integer (int64)",
    "sri": "boolean",
    "strategyDescriptionSwe": "string",
    "tags": [
      "string"
    ],
    "ter": "number (double)",
    "ticker": "string",
    "tradeFeeDisabled": "boolean",
    "type": "string",
    "ucits": "boolean",
    "url": "string",
    "value": {
      "buy": "number (double)",
      "currency": "string",
      "currencyExchangeRate": "number (double)",
      "fiveYears": "number (double)",
      "last": "number (double)",
      "lastClosing": "number (double)",
      "lastClosingDate": "string",
      "lastPeriodUpdate": "string",
      "lastValueUpdated": "string",
      "oneMonth": "number (double)",
      "oneYear": "number (double)",
      "sell": "number (double)",
      "sixMonths": "number (double)",
      "thisYear": "number (double)",
      "threeMonths": "number (double)",
      "threeYears": "number (double)"
    }
  },
  "fraction": "number (double)"
}

TemplatePortfolioDistributionUpdate: object

distribution: TemplatePortfolioDistributionUpdateItem
TemplatePortfolioDistributionUpdateItem
id: string
name: string
Example
{
  "distribution": [
    {
      "assetId": "string",
      "currentFraction": "number (double)",
      "updatedFraction": "number (double)"
    }
  ],
  "id": "string",
  "name": "string"
}

TemplatePortfolioDistributionUpdateItem: object

assetId: string
currentFraction: Decimal
updatedFraction: Decimal
Example
{
  "assetId": "string",
  "currentFraction": "number (double)",
  "updatedFraction": "number (double)"
}

TemplatePortfolioPart: object

assetId: string
fraction: Decimal
Example
{
  "assetId": "string",
  "fraction": "number (double)"
}

TemplatePortfolioPatch: object

distribution: FieldPatch«List«TemplatePortfolioPatchDistributionPart»»
estimatedReturn: FieldPatch«Decimal»
maxDD: FieldPatch«Decimal»
name: FieldPatch«string»
targetDistribution: FieldPatch«TargetDistribution»
targetVar: FieldPatch«Decimal»
trackingPortfolio: FieldPatch«string»
var: FieldPatch«Decimal»
volatility: FieldPatch«Decimal»
Example
{
  "distribution": {
    "action": "string",
    "value": [
      {
        "assetId": "string",
        "fraction": "number (double)"
      }
    ]
  },
  "estimatedReturn": {
    "action": "string",
    "value": "number (double)"
  },
  "maxDD": {
    "action": "string",
    "value": "number (double)"
  },
  "name": {
    "action": "string",
    "value": "string"
  },
  "targetDistribution": {
    "action": "string",
    "value": {
      "alternative": "number (double)",
      "bonds": "number (double)",
      "commodities": "number (double)",
      "stocks": "number (double)"
    }
  },
  "targetVar": {
    "action": "string",
    "value": "number (double)"
  },
  "trackingPortfolio": {
    "action": "string",
    "value": "string"
  },
  "var": {
    "action": "string",
    "value": "number (double)"
  },
  "volatility": {
    "action": "string",
    "value": "number (double)"
  }
}

TemplatePortfolioPatchDistributionPart: object

assetId: string
fraction: Decimal
Example
{
  "assetId": "string",
  "fraction": "number (double)"
}

TemplatePortfolioReplacementResult: object

customUpdateCount: integer (int32)
updatedTemplates: TemplatePortfolio
TemplatePortfolio
Example
{
  "customUpdateCount": "integer (int32)",
  "updatedTemplates": [
    {
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "estimatedReturn": "number (double)",
      "id": "string",
      "lastDistributionChange": "integer (int64)",
      "lastDistributionRefresh": "integer (int64)",
      "maxDD": "number (double)",
      "name": "string",
      "strategyIndex": "string",
      "targetDistribution": {
        "alternative": "number (double)",
        "bonds": "number (double)",
        "commodities": "number (double)",
        "stocks": "number (double)"
      },
      "targetVar": "number (double)",
      "trackingPortfolio": "string",
      "type": "string",
      "var": "number (double)",
      "volatility": "number (double)"
    }
  ]
}

TimeSeriesEntry: object

dateTime: DateTimeRepresentation
value: Decimal
Example
{
  "dateTime": "string",
  "value": "number (double)"
}

TimestampedValue«boolean»: object

updated: DateTimeRepresentation
value: boolean
Example
{
  "updated": "string",
  "value": "boolean"
}

TokenizedPageActionCodeActionCodeWithUrl: object

content: ActionCodeWithUrl
ActionCodeWithUrl
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "activationUrl": "string",
      "activatorAction": "string",
      "activatorActionProps": {
        "initialValue": "number (double)"
      },
      "created": "string",
      "description": "string",
      "expiration": "string",
      "id": "string",
      "issuer": "string",
      "issuerAction": "string",
      "issuerActionCondition": "string",
      "issuerActionConditionProps": "object",
      "issuerActionProps": {
        "initialValue": "number (double)"
      },
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageActionCodeActivation: object

content: ActionCodeActivation
ActionCodeActivation
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "activationDate": "string",
      "activator": "string",
      "activatorValue": "number (double)",
      "code": {
        "activatorAction": "string",
        "activatorActionProps": {
          "initialValue": "number (double)"
        },
        "created": "string",
        "description": "string",
        "expiration": "string",
        "id": "string",
        "issuer": "string",
        "issuerAction": "string",
        "issuerActionCondition": "string",
        "issuerActionConditionProps": "object",
        "issuerActionProps": {
          "initialValue": "number (double)"
        },
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "issuerActivationDate": "string",
      "issuerValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageActionCodeActivationExternal: object

content: ActionCodeUserActivation
ActionCodeUserActivation
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "action": "string",
      "actionProps": {
        "initialValue": "number (double)"
      },
      "activated": "string",
      "codeId": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "role": "string",
      "type": "string",
      "value": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageBwFile: object

content: BwFile
BwFile
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "contentType": "string",
      "created": "string",
      "error": "string",
      "fileContentIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "fileName": "string",
      "fileSourceIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "id": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageCustomTemplateLog: object

content: CustomTemplateLogEntry«object»
CustomTemplateLogEntry«object»
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "logEntryType": "string",
      "ownerId": "string",
      "payload": "object",
      "templateId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageLead: object

content: Lead
Lead
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "converted": "string",
      "created": "string",
      "email": "string",
      "id": "string",
      "name": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "onboarding": "boolean",
      "pensionPlan": "boolean",
      "phone": "string",
      "privacyPolicyAcceptVersion": "integer (int32)",
      "shortName": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPagePendingCustomerDeletion: object

content: PendingCustomerDeletion
PendingCustomerDeletion
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "createdTimestamp": "integer (int64)",
      "customerId": "string",
      "customerType": "string",
      "deleteTimestamp": "integer (int64)",
      "lastTransactionTimestamp": "integer (int64)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPagePortfolioListItem: object

content: PortfolioListItem
PortfolioListItem
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "accountType": "string",
      "clientId": "string",
      "deleted": "boolean",
      "endDate": "string",
      "investmentStrategyType": "string",
      "lastUpdate": "string",
      "name": "string",
      "owner": {
        "identifier": "integer (int64)",
        "name": "string",
        "ownerType": "string",
        "uuid": "string"
      },
      "portfolioIndex": "integer (int32)",
      "riskLevel": "string",
      "startDate": "string",
      "templatePortfolio": {
        "distribution": [
          {
            "asset": {
              "activeManagement": "boolean",
              "added": "string",
              "assetClass": "string",
              "aum": "number (double)",
              "aumCurrency": "string",
              "aumDate": "string",
              "baseValue": {
                "lastClosing": "number (double)",
                "lastClosingDate": "string"
              },
              "benchmarkName": "string",
              "categorySwe": "string",
              "ceo": "string",
              "commentsSwe": "string",
              "country": "string",
              "currency": "string",
              "currencyAllocation": "object",
              "currencyAllocationDate": "string",
              "currencyExchangeFeeDisabled": "boolean",
              "currencyHedged": "boolean",
              "dataSourceExchangeCode": "string",
              "descriptionSwe": "string",
              "dividendCurrency": "string",
              "dividendFrequency": "string",
              "dividendYield": "number (double)",
              "exchangeCode": "string",
              "geoAllocation": "object",
              "geoAllocationDate": "string",
              "geography": "string",
              "holdingsAllocation": "object",
              "holdingsAllocationDate": "string",
              "id": "string",
              "inceptionDate": "string",
              "index": "integer (int32)",
              "isActiveModel": "boolean",
              "isActivePlatform": "boolean",
              "isCollectingData": "boolean",
              "isTradeStopped": "boolean",
              "isin": "string",
              "issuingCompany": "string",
              "kiidUrl": "string",
              "market": "string",
              "metricBeta": "number (double)",
              "metricPe": "number (double)",
              "metricPs": "number (double)",
              "msciEsgDataDate": "string",
              "msciEsgDataPresent": "boolean",
              "msciEsgQualityScore": "number (double)",
              "msciEsgQualityScorePctlGlobal": "number (double)",
              "msciEsgQualityScorePctlPeer": "number (double)",
              "msciEsgRating": "string",
              "msciSustainableImpactPct": "number (double)",
              "msciWaCO2i": "number (double)",
              "name": "string",
              "notes": "string",
              "numEmployees": "integer (int32)",
              "numberOfHoldings": "integer (int32)",
              "numberOfHoldingsDate": "string",
              "orderRoute": "string",
              "replicationStrategy": "string",
              "riskFactor": "string",
              "riskLevel": "integer (int32)",
              "sectors": [
                "string"
              ],
              "sharesTotal": "integer (int32)",
              "shortName": "string",
              "simpleId": "integer (int64)",
              "sri": "boolean",
              "strategyDescriptionSwe": "string",
              "tags": [
                "string"
              ],
              "ter": "number (double)",
              "ticker": "string",
              "tradeFeeDisabled": "boolean",
              "type": "string",
              "ucits": "boolean",
              "url": "string",
              "value": {
                "buy": "number (double)",
                "currency": "string",
                "currencyExchangeRate": "number (double)",
                "fiveYears": "number (double)",
                "last": "number (double)",
                "lastClosing": "number (double)",
                "lastClosingDate": "string",
                "lastPeriodUpdate": "string",
                "lastValueUpdated": "string",
                "oneMonth": "number (double)",
                "oneYear": "number (double)",
                "sell": "number (double)",
                "sixMonths": "number (double)",
                "thisYear": "number (double)",
                "threeMonths": "number (double)",
                "threeYears": "number (double)"
              }
            },
            "fraction": "number (double)"
          }
        ],
        "estimatedReturn": "number (double)",
        "id": "string",
        "lastDistributionChange": "integer (int64)",
        "lastDistributionRefresh": "integer (int64)",
        "maxDD": "number (double)",
        "name": "string",
        "strategyIndex": "string",
        "targetDistribution": {
          "alternative": "number (double)",
          "bonds": "number (double)",
          "commodities": "number (double)",
          "stocks": "number (double)"
        },
        "targetVar": "number (double)",
        "trackingPortfolio": "string",
        "type": "string",
        "var": "number (double)",
        "volatility": "number (double)"
      },
      "uuid": "string",
      "value": {
        "historicalReturn": "number (double)",
        "returnCurrentQuarter": "number (double)",
        "returnCurrentYear": "number (double)",
        "returnValue": "number (double)",
        "returnValueLatestMonth": "number (double)",
        "returnValueLatestYear": "number (double)",
        "totalEarnings": "number (double)",
        "totalInvested": "number (double)",
        "totalValue": "number (double)",
        "totalWithdrawn": "number (double)",
        "updated": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPagePortfolioLogEntry: object

content: PortfolioLogEntry
PortfolioLogEntry
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPagePortfolioTradeOrder: object

content: PortfolioTradeOrder
PortfolioTradeOrder
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "assets": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "tradeUnit": "string",
          "value": "number (double)"
        }
      ],
      "created": "string",
      "currency": "string",
      "id": "string",
      "marketOrderId": "string",
      "orderEstimates": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currencyExchangeFee": "number (double)",
          "currencyExchangeRate": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "price": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "tradeFee": "number (double)",
          "type": "string",
          "value": "number (double)"
        }
      ],
      "orderState": "string",
      "ownerId": "string",
      "portfolioId": "string",
      "recurringSource": "string",
      "simpleId": "integer (int32)",
      "sourceId": "string",
      "sourceType": "string",
      "targetId": "string",
      "targetType": "string",
      "tradeGroupId": "string",
      "tradeId": "string",
      "transactionDay": "integer (int32)",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageSharedCustomTemplate: object

content: SharedCustomTemplate
SharedCustomTemplate
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "accessibility": "string",
      "created": "string",
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "id": "string",
      "meta": {
        "assetTypes": [
          "string"
        ],
        "categories": [
          "string"
        ],
        "description": "string",
        "grade": "integer (int32)",
        "name": "string",
        "rank": "integer (int32)",
        "sri": "boolean",
        "status": {
          "level": "string",
          "trigger": "string"
        }
      },
      "ownerId": "string",
      "published": "string",
      "sharerProfile": {
        "alias": "string",
        "description": "string",
        "facebookLink": "string",
        "id": "string",
        "instagramLink": "string",
        "linkedinLink": "string",
        "profilePicture": "string",
        "ticktockLink": "string",
        "topTraderData": {
          "aumFraction": "number (double)",
          "depositFraction": "number (double)",
          "enabled": "boolean",
          "payoutMethod": "string"
        },
        "userUuid": "string",
        "verified": "boolean"
      },
      "ter": "number (double)",
      "trackingPortfolioId": "string",
      "value": {
        "aum": "number (double)",
        "distribution": {
          "alternatives": "integer (int32)",
          "commodities": "integer (int32)",
          "equity": "integer (int32)",
          "fixedIncome": "integer (int32)"
        },
        "fiveYears": "number (double)",
        "followers": "integer (int32)",
        "lastPeriodUpdate": "string",
        "oneMonth": "number (double)",
        "oneYear": "number (double)",
        "sixMonths": "number (double)",
        "thisYear": "number (double)",
        "threeMonths": "number (double)",
        "threeYears": "number (double)"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageTransaction: object

content: Transaction
Transaction
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageUserWithPensionDetails: object

content: UserWithKnowledge
UserWithKnowledge
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "customerKnowledge": {
        "cashSources": "object",
        "citizenship": [
          "string"
        ],
        "completedAcceptActions": [
          {
            "action": "string",
            "timestamp": "string",
            "version": "integer (int32)"
          }
        ],
        "completedKnowledgeTests": [
          {
            "completionDate": "string",
            "questions": [
              {
                "answerId": "string",
                "questionId": "string"
              }
            ],
            "type": "string",
            "version": "integer (int32)"
          }
        ],
        "depositPeriodicity": "string",
        "employment": "string",
        "funds": "boolean",
        "income": "number (double)",
        "investmentPurpose": "object",
        "investmentSize": "string",
        "liquidAssets": "string",
        "loansAndCredits": "boolean",
        "lossKnowledge": "boolean",
        "ownage": "boolean",
        "pep": "string",
        "pepPosition": "string",
        "pepRelation": "string",
        "pepRelationPosition": "string",
        "privacyPolicyAccept": {
          "updated": "string",
          "value": "boolean"
        },
        "taxResidence": "string",
        "taxResidenceSweden": "boolean",
        "tin": "string",
        "transferSource": "string",
        "unrealizedLiquidAssets": "string",
        "version": "integer (int32)",
        "withdrawalPeriodicity": "string"
      },
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      },
      "userId": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageUserWithValue: object

content: UserWithValue
UserWithValue
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "investedValue": "number (double)",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "organizationsCount": "number (double)",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "totalValue": "number (double)",
      "userProfileAlias": "string",
      "uuid": "string",
      "withdrawnValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageWithAssets: object

content: Asset
Asset
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "activeManagement": "boolean",
      "added": "string",
      "assetClass": "string",
      "aum": "number (double)",
      "aumCurrency": "string",
      "aumDate": "string",
      "baseValue": {
        "lastClosing": "number (double)",
        "lastClosingDate": "string"
      },
      "benchmarkName": "string",
      "categorySwe": "string",
      "ceo": "string",
      "commentsSwe": "string",
      "country": "string",
      "currency": "string",
      "currencyAllocation": "object",
      "currencyAllocationDate": "string",
      "currencyExchangeFeeDisabled": "boolean",
      "currencyHedged": "boolean",
      "dataSourceExchangeCode": "string",
      "descriptionSwe": "string",
      "dividendCurrency": "string",
      "dividendFrequency": "string",
      "dividendYield": "number (double)",
      "exchangeCode": "string",
      "geoAllocation": "object",
      "geoAllocationDate": "string",
      "geography": "string",
      "holdingsAllocation": "object",
      "holdingsAllocationDate": "string",
      "id": "string",
      "inceptionDate": "string",
      "index": "integer (int32)",
      "isActiveModel": "boolean",
      "isActivePlatform": "boolean",
      "isCollectingData": "boolean",
      "isTradeStopped": "boolean",
      "isin": "string",
      "issuingCompany": "string",
      "kiidUrl": "string",
      "market": "string",
      "metricBeta": "number (double)",
      "metricPe": "number (double)",
      "metricPs": "number (double)",
      "msciEsgDataDate": "string",
      "msciEsgDataPresent": "boolean",
      "msciEsgQualityScore": "number (double)",
      "msciEsgQualityScorePctlGlobal": "number (double)",
      "msciEsgQualityScorePctlPeer": "number (double)",
      "msciEsgRating": "string",
      "msciSustainableImpactPct": "number (double)",
      "msciWaCO2i": "number (double)",
      "name": "string",
      "notes": "string",
      "numEmployees": "integer (int32)",
      "numberOfHoldings": "integer (int32)",
      "numberOfHoldingsDate": "string",
      "orderRoute": "string",
      "replicationStrategy": "string",
      "riskFactor": "string",
      "riskLevel": "integer (int32)",
      "sectors": [
        "string"
      ],
      "sharesTotal": "integer (int32)",
      "shortName": "string",
      "simpleId": "integer (int64)",
      "sri": "boolean",
      "strategyDescriptionSwe": "string",
      "tags": [
        "string"
      ],
      "ter": "number (double)",
      "ticker": "string",
      "tradeFeeDisabled": "boolean",
      "type": "string",
      "ucits": "boolean",
      "url": "string",
      "value": {
        "buy": "number (double)",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "fiveYears": "number (double)",
        "last": "number (double)",
        "lastClosing": "number (double)",
        "lastClosingDate": "string",
        "lastPeriodUpdate": "string",
        "lastValueUpdated": "string",
        "oneMonth": "number (double)",
        "oneYear": "number (double)",
        "sell": "number (double)",
        "sixMonths": "number (double)",
        "thisYear": "number (double)",
        "threeMonths": "number (double)",
        "threeYears": "number (double)"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageWithNotificationGenerators: object

content: NotificationGenerator
NotificationGenerator
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "filter": {
        "filter": "object"
      },
      "id": "string",
      "medium": "string",
      "name": "string",
      "period": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageWithNotificationHits: object

content: NotificationHit
NotificationHit
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "customerId": "string",
      "customerType": "string",
      "targetExternalId": "string",
      "targetId": "string",
      "targetName": "string",
      "targetType": "string",
      "templateValues": "object"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageWithNotificationTemplates: object

content: NotificationTemplate
NotificationTemplate
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "content": "object",
      "contentType": "string",
      "expiration": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPageWithNotifications: object

content: Notification
Notification
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "generator": {
        "created": "string",
        "enabled": "boolean",
        "filter": {
          "filter": "object"
        },
        "id": "string",
        "medium": "string",
        "name": "string",
        "period": "string",
        "template": {
          "content": "object",
          "contentType": "string",
          "expiration": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        }
      },
      "generatorId": "string",
      "id": "string",
      "ownerId": "string",
      "status": "string",
      "targetId": "string",
      "targetType": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«ActionCodeActivation»: object

content: ActionCodeActivation
ActionCodeActivation
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "activationDate": "string",
      "activator": "string",
      "activatorValue": "number (double)",
      "code": {
        "activatorAction": "string",
        "activatorActionProps": {
          "initialValue": "number (double)"
        },
        "created": "string",
        "description": "string",
        "expiration": "string",
        "id": "string",
        "issuer": "string",
        "issuerAction": "string",
        "issuerActionCondition": "string",
        "issuerActionConditionProps": "object",
        "issuerActionProps": {
          "initialValue": "number (double)"
        },
        "name": "string",
        "type": "string"
      },
      "id": "string",
      "issuerActivationDate": "string",
      "issuerValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«ActionCodeUserActivation»: object

content: ActionCodeUserActivation
ActionCodeUserActivation
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "action": "string",
      "actionProps": {
        "initialValue": "number (double)"
      },
      "activated": "string",
      "codeId": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "role": "string",
      "type": "string",
      "value": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«ActionCodeWithUrl»: object

content: ActionCodeWithUrl
ActionCodeWithUrl
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "activationUrl": "string",
      "activatorAction": "string",
      "activatorActionProps": {
        "initialValue": "number (double)"
      },
      "created": "string",
      "description": "string",
      "expiration": "string",
      "id": "string",
      "issuer": "string",
      "issuerAction": "string",
      "issuerActionCondition": "string",
      "issuerActionConditionProps": "object",
      "issuerActionProps": {
        "initialValue": "number (double)"
      },
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«AdminLogEntry»: object

content: AdminLogEntry
AdminLogEntry
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "adminId": "string",
      "adminLogEntryType": "string",
      "payload": "object",
      "targetId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«AssetStorageCheckResultItem»: object

content: AssetStorageCheckResultItem
AssetStorageCheckResultItem
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "fileId": "string",
      "logItemId": "string",
      "result": {
        "date": "string",
        "fileType": "string",
        "result": [
          {
            "assetId": "string",
            "bankAmount": "number (double)",
            "isin": "string",
            "successful": "boolean",
            "systemAmount": "number (double)"
          }
        ],
        "successful": "boolean"
      },
      "resultType": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«Asset»: object

content: Asset
Asset
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "activeManagement": "boolean",
      "added": "string",
      "assetClass": "string",
      "aum": "number (double)",
      "aumCurrency": "string",
      "aumDate": "string",
      "baseValue": {
        "lastClosing": "number (double)",
        "lastClosingDate": "string"
      },
      "benchmarkName": "string",
      "categorySwe": "string",
      "ceo": "string",
      "commentsSwe": "string",
      "country": "string",
      "currency": "string",
      "currencyAllocation": "object",
      "currencyAllocationDate": "string",
      "currencyExchangeFeeDisabled": "boolean",
      "currencyHedged": "boolean",
      "dataSourceExchangeCode": "string",
      "descriptionSwe": "string",
      "dividendCurrency": "string",
      "dividendFrequency": "string",
      "dividendYield": "number (double)",
      "exchangeCode": "string",
      "geoAllocation": "object",
      "geoAllocationDate": "string",
      "geography": "string",
      "holdingsAllocation": "object",
      "holdingsAllocationDate": "string",
      "id": "string",
      "inceptionDate": "string",
      "index": "integer (int32)",
      "isActiveModel": "boolean",
      "isActivePlatform": "boolean",
      "isCollectingData": "boolean",
      "isTradeStopped": "boolean",
      "isin": "string",
      "issuingCompany": "string",
      "kiidUrl": "string",
      "market": "string",
      "metricBeta": "number (double)",
      "metricPe": "number (double)",
      "metricPs": "number (double)",
      "msciEsgDataDate": "string",
      "msciEsgDataPresent": "boolean",
      "msciEsgQualityScore": "number (double)",
      "msciEsgQualityScorePctlGlobal": "number (double)",
      "msciEsgQualityScorePctlPeer": "number (double)",
      "msciEsgRating": "string",
      "msciSustainableImpactPct": "number (double)",
      "msciWaCO2i": "number (double)",
      "name": "string",
      "notes": "string",
      "numEmployees": "integer (int32)",
      "numberOfHoldings": "integer (int32)",
      "numberOfHoldingsDate": "string",
      "orderRoute": "string",
      "replicationStrategy": "string",
      "riskFactor": "string",
      "riskLevel": "integer (int32)",
      "sectors": [
        "string"
      ],
      "sharesTotal": "integer (int32)",
      "shortName": "string",
      "simpleId": "integer (int64)",
      "sri": "boolean",
      "strategyDescriptionSwe": "string",
      "tags": [
        "string"
      ],
      "ter": "number (double)",
      "ticker": "string",
      "tradeFeeDisabled": "boolean",
      "type": "string",
      "ucits": "boolean",
      "url": "string",
      "value": {
        "buy": "number (double)",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "fiveYears": "number (double)",
        "last": "number (double)",
        "lastClosing": "number (double)",
        "lastClosingDate": "string",
        "lastPeriodUpdate": "string",
        "lastValueUpdated": "string",
        "oneMonth": "number (double)",
        "oneYear": "number (double)",
        "sell": "number (double)",
        "sixMonths": "number (double)",
        "thisYear": "number (double)",
        "threeMonths": "number (double)",
        "threeYears": "number (double)"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«AsyncTaskResultItem«object»»: object

content: AsyncTaskResultItem«object»
AsyncTaskResultItem«object»
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "identifier": "string",
      "payload": "object"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«AsyncTask«object»»: object

content: AsyncTask«object»
AsyncTask«object»
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "creator": "string",
      "id": "string",
      "identifier": "string",
      "message": "string",
      "payload": "object",
      "status": "string",
      "type": "string",
      "updated": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«BwFile»: object

content: BwFile
BwFile
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "contentType": "string",
      "created": "string",
      "error": "string",
      "fileContentIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "fileName": "string",
      "fileSourceIdentifier": {
        "identifier": "string",
        "protocol": "string"
      },
      "id": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«CustomTemplateLogEntry«object»»: object

content: CustomTemplateLogEntry«object»
CustomTemplateLogEntry«object»
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "logEntryType": "string",
      "ownerId": "string",
      "payload": "object",
      "templateId": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«Lead»: object

content: Lead
Lead
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "converted": "string",
      "created": "string",
      "email": "string",
      "id": "string",
      "name": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "onboarding": "boolean",
      "pensionPlan": "boolean",
      "phone": "string",
      "privacyPolicyAcceptVersion": "integer (int32)",
      "shortName": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«NotificationGenerator»: object

content: NotificationGenerator
NotificationGenerator
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "filter": {
        "filter": "object"
      },
      "id": "string",
      "medium": "string",
      "name": "string",
      "period": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«NotificationHit»: object

content: NotificationHit
NotificationHit
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "customerId": "string",
      "customerType": "string",
      "targetExternalId": "string",
      "targetId": "string",
      "targetName": "string",
      "targetType": "string",
      "templateValues": "object"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«NotificationTemplate»: object

content: NotificationTemplate
NotificationTemplate
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "content": "object",
      "contentType": "string",
      "expiration": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«Notification»: object

content: Notification
Notification
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "created": "string",
      "enabled": "boolean",
      "generator": {
        "created": "string",
        "enabled": "boolean",
        "filter": {
          "filter": "object"
        },
        "id": "string",
        "medium": "string",
        "name": "string",
        "period": "string",
        "template": {
          "content": "object",
          "contentType": "string",
          "expiration": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        }
      },
      "generatorId": "string",
      "id": "string",
      "ownerId": "string",
      "status": "string",
      "targetId": "string",
      "targetType": "string",
      "template": {
        "content": "object",
        "contentType": "string",
        "expiration": "string",
        "id": "string",
        "name": "string",
        "type": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«OrganizationListItem»: object

content: OrganizationListItem
OrganizationListItem
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "created": "string",
      "email": "string",
      "lei": "string",
      "name": "string",
      "organizationNumber": {
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string",
        "vatnumber": "string"
      },
      "principal": {
        "name": "string",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        }
      },
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "status": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«PendingCustomerDeletion»: object

content: PendingCustomerDeletion
PendingCustomerDeletion
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "createdTimestamp": "integer (int64)",
      "customerId": "string",
      "customerType": "string",
      "deleteTimestamp": "integer (int64)",
      "lastTransactionTimestamp": "integer (int64)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«PortfolioListItem»: object

content: PortfolioListItem
PortfolioListItem
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "accountType": "string",
      "clientId": "string",
      "deleted": "boolean",
      "endDate": "string",
      "investmentStrategyType": "string",
      "lastUpdate": "string",
      "name": "string",
      "owner": {
        "identifier": "integer (int64)",
        "name": "string",
        "ownerType": "string",
        "uuid": "string"
      },
      "portfolioIndex": "integer (int32)",
      "riskLevel": "string",
      "startDate": "string",
      "templatePortfolio": {
        "distribution": [
          {
            "asset": {
              "activeManagement": "boolean",
              "added": "string",
              "assetClass": "string",
              "aum": "number (double)",
              "aumCurrency": "string",
              "aumDate": "string",
              "baseValue": {
                "lastClosing": "number (double)",
                "lastClosingDate": "string"
              },
              "benchmarkName": "string",
              "categorySwe": "string",
              "ceo": "string",
              "commentsSwe": "string",
              "country": "string",
              "currency": "string",
              "currencyAllocation": "object",
              "currencyAllocationDate": "string",
              "currencyExchangeFeeDisabled": "boolean",
              "currencyHedged": "boolean",
              "dataSourceExchangeCode": "string",
              "descriptionSwe": "string",
              "dividendCurrency": "string",
              "dividendFrequency": "string",
              "dividendYield": "number (double)",
              "exchangeCode": "string",
              "geoAllocation": "object",
              "geoAllocationDate": "string",
              "geography": "string",
              "holdingsAllocation": "object",
              "holdingsAllocationDate": "string",
              "id": "string",
              "inceptionDate": "string",
              "index": "integer (int32)",
              "isActiveModel": "boolean",
              "isActivePlatform": "boolean",
              "isCollectingData": "boolean",
              "isTradeStopped": "boolean",
              "isin": "string",
              "issuingCompany": "string",
              "kiidUrl": "string",
              "market": "string",
              "metricBeta": "number (double)",
              "metricPe": "number (double)",
              "metricPs": "number (double)",
              "msciEsgDataDate": "string",
              "msciEsgDataPresent": "boolean",
              "msciEsgQualityScore": "number (double)",
              "msciEsgQualityScorePctlGlobal": "number (double)",
              "msciEsgQualityScorePctlPeer": "number (double)",
              "msciEsgRating": "string",
              "msciSustainableImpactPct": "number (double)",
              "msciWaCO2i": "number (double)",
              "name": "string",
              "notes": "string",
              "numEmployees": "integer (int32)",
              "numberOfHoldings": "integer (int32)",
              "numberOfHoldingsDate": "string",
              "orderRoute": "string",
              "replicationStrategy": "string",
              "riskFactor": "string",
              "riskLevel": "integer (int32)",
              "sectors": [
                "string"
              ],
              "sharesTotal": "integer (int32)",
              "shortName": "string",
              "simpleId": "integer (int64)",
              "sri": "boolean",
              "strategyDescriptionSwe": "string",
              "tags": [
                "string"
              ],
              "ter": "number (double)",
              "ticker": "string",
              "tradeFeeDisabled": "boolean",
              "type": "string",
              "ucits": "boolean",
              "url": "string",
              "value": {
                "buy": "number (double)",
                "currency": "string",
                "currencyExchangeRate": "number (double)",
                "fiveYears": "number (double)",
                "last": "number (double)",
                "lastClosing": "number (double)",
                "lastClosingDate": "string",
                "lastPeriodUpdate": "string",
                "lastValueUpdated": "string",
                "oneMonth": "number (double)",
                "oneYear": "number (double)",
                "sell": "number (double)",
                "sixMonths": "number (double)",
                "thisYear": "number (double)",
                "threeMonths": "number (double)",
                "threeYears": "number (double)"
              }
            },
            "fraction": "number (double)"
          }
        ],
        "estimatedReturn": "number (double)",
        "id": "string",
        "lastDistributionChange": "integer (int64)",
        "lastDistributionRefresh": "integer (int64)",
        "maxDD": "number (double)",
        "name": "string",
        "strategyIndex": "string",
        "targetDistribution": {
          "alternative": "number (double)",
          "bonds": "number (double)",
          "commodities": "number (double)",
          "stocks": "number (double)"
        },
        "targetVar": "number (double)",
        "trackingPortfolio": "string",
        "type": "string",
        "var": "number (double)",
        "volatility": "number (double)"
      },
      "uuid": "string",
      "value": {
        "historicalReturn": "number (double)",
        "returnCurrentQuarter": "number (double)",
        "returnCurrentYear": "number (double)",
        "returnValue": "number (double)",
        "returnValueLatestMonth": "number (double)",
        "returnValueLatestYear": "number (double)",
        "totalEarnings": "number (double)",
        "totalInvested": "number (double)",
        "totalValue": "number (double)",
        "totalWithdrawn": "number (double)",
        "updated": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«PortfolioLogEntry»: object

content: PortfolioLogEntry
PortfolioLogEntry
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "ownerId": "string",
      "payload": "object",
      "portfolioId": "string",
      "portfolioLogEntryType": "string",
      "timestamp": "integer (int64)",
      "type": "string",
      "userId": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«PortfolioTradeOrder»: object

content: PortfolioTradeOrder
PortfolioTradeOrder
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "assets": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "tradeUnit": "string",
          "value": "number (double)"
        }
      ],
      "created": "string",
      "currency": "string",
      "id": "string",
      "marketOrderId": "string",
      "orderEstimates": [
        {
          "amount": "number (double)",
          "assetId": "string",
          "currencyExchangeFee": "number (double)",
          "currencyExchangeRate": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "price": {
            "price": "number (double)",
            "timestamp": "string"
          },
          "tradeFee": "number (double)",
          "type": "string",
          "value": "number (double)"
        }
      ],
      "orderState": "string",
      "ownerId": "string",
      "portfolioId": "string",
      "recurringSource": "string",
      "simpleId": "integer (int32)",
      "sourceId": "string",
      "sourceType": "string",
      "targetId": "string",
      "targetType": "string",
      "tradeGroupId": "string",
      "tradeId": "string",
      "transactionDay": "integer (int32)",
      "type": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«SharedCustomTemplate»: object

content: SharedCustomTemplate
SharedCustomTemplate
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "accessibility": "string",
      "created": "string",
      "distribution": [
        {
          "asset": {
            "activeManagement": "boolean",
            "added": "string",
            "assetClass": "string",
            "aum": "number (double)",
            "aumCurrency": "string",
            "aumDate": "string",
            "baseValue": {
              "lastClosing": "number (double)",
              "lastClosingDate": "string"
            },
            "benchmarkName": "string",
            "categorySwe": "string",
            "ceo": "string",
            "commentsSwe": "string",
            "country": "string",
            "currency": "string",
            "currencyAllocation": "object",
            "currencyAllocationDate": "string",
            "currencyExchangeFeeDisabled": "boolean",
            "currencyHedged": "boolean",
            "dataSourceExchangeCode": "string",
            "descriptionSwe": "string",
            "dividendCurrency": "string",
            "dividendFrequency": "string",
            "dividendYield": "number (double)",
            "exchangeCode": "string",
            "geoAllocation": "object",
            "geoAllocationDate": "string",
            "geography": "string",
            "holdingsAllocation": "object",
            "holdingsAllocationDate": "string",
            "id": "string",
            "inceptionDate": "string",
            "index": "integer (int32)",
            "isActiveModel": "boolean",
            "isActivePlatform": "boolean",
            "isCollectingData": "boolean",
            "isTradeStopped": "boolean",
            "isin": "string",
            "issuingCompany": "string",
            "kiidUrl": "string",
            "market": "string",
            "metricBeta": "number (double)",
            "metricPe": "number (double)",
            "metricPs": "number (double)",
            "msciEsgDataDate": "string",
            "msciEsgDataPresent": "boolean",
            "msciEsgQualityScore": "number (double)",
            "msciEsgQualityScorePctlGlobal": "number (double)",
            "msciEsgQualityScorePctlPeer": "number (double)",
            "msciEsgRating": "string",
            "msciSustainableImpactPct": "number (double)",
            "msciWaCO2i": "number (double)",
            "name": "string",
            "notes": "string",
            "numEmployees": "integer (int32)",
            "numberOfHoldings": "integer (int32)",
            "numberOfHoldingsDate": "string",
            "orderRoute": "string",
            "replicationStrategy": "string",
            "riskFactor": "string",
            "riskLevel": "integer (int32)",
            "sectors": [
              "string"
            ],
            "sharesTotal": "integer (int32)",
            "shortName": "string",
            "simpleId": "integer (int64)",
            "sri": "boolean",
            "strategyDescriptionSwe": "string",
            "tags": [
              "string"
            ],
            "ter": "number (double)",
            "ticker": "string",
            "tradeFeeDisabled": "boolean",
            "type": "string",
            "ucits": "boolean",
            "url": "string",
            "value": {
              "buy": "number (double)",
              "currency": "string",
              "currencyExchangeRate": "number (double)",
              "fiveYears": "number (double)",
              "last": "number (double)",
              "lastClosing": "number (double)",
              "lastClosingDate": "string",
              "lastPeriodUpdate": "string",
              "lastValueUpdated": "string",
              "oneMonth": "number (double)",
              "oneYear": "number (double)",
              "sell": "number (double)",
              "sixMonths": "number (double)",
              "thisYear": "number (double)",
              "threeMonths": "number (double)",
              "threeYears": "number (double)"
            }
          },
          "fraction": "number (double)"
        }
      ],
      "id": "string",
      "meta": {
        "assetTypes": [
          "string"
        ],
        "categories": [
          "string"
        ],
        "description": "string",
        "grade": "integer (int32)",
        "name": "string",
        "rank": "integer (int32)",
        "sri": "boolean",
        "status": {
          "level": "string",
          "trigger": "string"
        }
      },
      "ownerId": "string",
      "published": "string",
      "sharerProfile": {
        "alias": "string",
        "description": "string",
        "facebookLink": "string",
        "id": "string",
        "instagramLink": "string",
        "linkedinLink": "string",
        "profilePicture": "string",
        "ticktockLink": "string",
        "topTraderData": {
          "aumFraction": "number (double)",
          "depositFraction": "number (double)",
          "enabled": "boolean",
          "payoutMethod": "string"
        },
        "userUuid": "string",
        "verified": "boolean"
      },
      "ter": "number (double)",
      "trackingPortfolioId": "string",
      "value": {
        "aum": "number (double)",
        "distribution": {
          "alternatives": "integer (int32)",
          "commodities": "integer (int32)",
          "equity": "integer (int32)",
          "fixedIncome": "integer (int32)"
        },
        "fiveYears": "number (double)",
        "followers": "integer (int32)",
        "lastPeriodUpdate": "string",
        "oneMonth": "number (double)",
        "oneYear": "number (double)",
        "sixMonths": "number (double)",
        "thisYear": "number (double)",
        "threeMonths": "number (double)",
        "threeYears": "number (double)"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«Transaction»: object

content: Transaction
Transaction
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«UserWithPensionDetails»: object

content: UserWithPensionDetails
UserWithPensionDetails
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "pensionFlag": "boolean",
      "pensionPortfolio": "boolean",
      "user": {
        "clientId": "string",
        "clientIdMigrationTarget": "string",
        "clientIdOriginal": "string",
        "confirmEmail": "string",
        "created": "string",
        "deleted": "string",
        "email": "string",
        "firstName": "string",
        "idProvider": "string",
        "lastName": "string",
        "newsletter": "boolean",
        "notifications": "boolean",
        "personalNumber": {
          "age": "integer (int32)",
          "canonical": "string",
          "canonicalAsLong": "integer (int64)",
          "prefix": "string"
        },
        "phone": "string",
        "premiumContact": {
          "email": "string",
          "imageUrl": "string",
          "name": "string",
          "phone": "string",
          "uuid": "string"
        },
        "premiumLevel": "string",
        "referrer": "string",
        "riskCategory": "string",
        "simpleId": "integer (int64)",
        "source": "string",
        "userProfileAlias": "string",
        "uuid": "string"
      }
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TokenizedPage«UserWithValue»: object

content: UserWithValue
UserWithValue
first: boolean
last: boolean
nextToken: string
size: integer (int32)
token: string
totalSize: integer (int32)
Example
{
  "content": [
    {
      "clientId": "string",
      "clientIdMigrationTarget": "string",
      "clientIdOriginal": "string",
      "confirmEmail": "string",
      "created": "string",
      "deleted": "string",
      "email": "string",
      "firstName": "string",
      "idProvider": "string",
      "investedValue": "number (double)",
      "lastName": "string",
      "newsletter": "boolean",
      "notifications": "boolean",
      "organizationsCount": "number (double)",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      },
      "phone": "string",
      "premiumContact": {
        "email": "string",
        "imageUrl": "string",
        "name": "string",
        "phone": "string",
        "uuid": "string"
      },
      "premiumLevel": "string",
      "referrer": "string",
      "riskCategory": "string",
      "simpleId": "integer (int64)",
      "source": "string",
      "totalValue": "number (double)",
      "userProfileAlias": "string",
      "uuid": "string",
      "withdrawnValue": "number (double)"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "nextToken": "string",
  "size": "integer (int32)",
  "token": "string",
  "totalSize": "integer (int32)"
}

TopTraderData: object

aumFraction: Decimal
depositFraction: Decimal
enabled: boolean
payoutMethod: string cash, invoice
Example
{
  "aumFraction": "number (double)",
  "depositFraction": "number (double)",
  "enabled": "boolean",
  "payoutMethod": "string"
}

TotalBalanceItem: object

assetId: string
invested: Decimal
isin: string
price: Decimal
storage: Decimal
type: string ETF, ETF_TEMP, CASH, STOCK, FUND
Example
{
  "assetId": "string",
  "invested": "number (double)",
  "isin": "string",
  "price": "number (double)",
  "storage": "number (double)",
  "type": "string"
}

TrackingLogTimeSeries: object

type: string NUM_USERS, NUM_USERS_W_VALUE, NUM_USERS_W_RECURRING, NUM_PORTFOLIOS, NUM_PORTFOLIOS_W_VALUE, AUM, ASSET_STORAGE_VALUE, ASSET_STORAGE_CASH_VALUE
values: TimeSeriesEntry
TimeSeriesEntry
Example
{
  "type": "string",
  "values": [
    {
      "dateTime": "string",
      "value": "number (double)"
    }
  ]
}

TrackingLogValue: object

type: string NUM_USERS, NUM_USERS_W_VALUE, NUM_USERS_W_RECURRING, NUM_PORTFOLIOS, NUM_PORTFOLIOS_W_VALUE, AUM, ASSET_STORAGE_VALUE, ASSET_STORAGE_CASH_VALUE
value: TimeSeriesEntry
Example
{
  "type": "string",
  "value": {
    "dateTime": "string",
    "value": "number (double)"
  }
}

TradeOrderCreatePayload: object

includedPortfolioTradeOrders: IncludedPortfolioTradeOrder
IncludedPortfolioTradeOrder
orders: TradeOrderItem
TradeOrderItem
Example
{
  "includedPortfolioTradeOrders": [
    {
      "portfolioId": "string",
      "portfolioTradeOrderId": "string"
    }
  ],
  "orders": [
    {
      "amount": "number (double)",
      "assetId": "string",
      "estimateAbsAmount": "number (double)",
      "estimatedPrice": "number (double)",
      "tradeMethod": "string",
      "type": "string",
      "unit": "string"
    }
  ]
}

TradeOrderEstimate: object

errors: object
estimates: TradeOrderEstimateItem
TradeOrderEstimateItem
includedPortfolioTradeOrders: IncludedPortfolioTradeOrder
IncludedPortfolioTradeOrder
Example
{
  "errors": "object",
  "estimates": [
    {
      "assetId": "string",
      "calculatedValue": {
        "buy": "number (double)",
        "currency": "string",
        "currencyExchangeRate": "number (double)",
        "last": "number (double)",
        "lastValueUpdated": "string",
        "sell": "number (double)"
      },
      "estimate": "number (double)",
      "estimateAbsAmount": "number (double)",
      "estimateTradeAmount": "number (double)",
      "estimationUnit": "string",
      "inStore": "number (double)",
      "tradeMethod": "string",
      "type": "string"
    }
  ],
  "includedPortfolioTradeOrders": [
    {
      "portfolioId": "string",
      "portfolioTradeOrderId": "string"
    }
  ]
}

TradeOrderEstimateItem: object

assetId: string
calculatedValue: InternalValueRepresentation
estimate: Decimal
estimateAbsAmount: Decimal
estimateTradeAmount: Decimal
estimationUnit: string VALUE, SHARES
inStore: Decimal
tradeMethod: string market, internal
type: string BUY, SELL, FAILED, NONE
Example
{
  "assetId": "string",
  "calculatedValue": {
    "buy": "number (double)",
    "currency": "string",
    "currencyExchangeRate": "number (double)",
    "last": "number (double)",
    "lastValueUpdated": "string",
    "sell": "number (double)"
  },
  "estimate": "number (double)",
  "estimateAbsAmount": "number (double)",
  "estimateTradeAmount": "number (double)",
  "estimationUnit": "string",
  "inStore": "number (double)",
  "tradeMethod": "string",
  "type": "string"
}

TradeOrderItem: object

amount: Decimal
assetId: string
estimateAbsAmount: Decimal
estimatedPrice: Decimal
tradeMethod: string market, internal
type: string BUY, SELL, FAILED, NONE
unit: string VALUE, SHARES
Example
{
  "amount": "number (double)",
  "assetId": "string",
  "estimateAbsAmount": "number (double)",
  "estimatedPrice": "number (double)",
  "tradeMethod": "string",
  "type": "string",
  "unit": "string"
}

Transaction: object

amount: Decimal
bulkUuid: string
created: integer (int64)
errorMessage: string
externalId: string
initiated: integer (int64)
internalId: string
owner: PortfolioOwner
portfolioUuid: string
protocol: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
recurringTransactionDate: DateTimeRepresentation
recurringTransactionId: string
status: string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
subTransactions: Transaction
Transaction
targetAccount: BankAccount
type: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
updated: integer (int64)
userUuid: string
uuid: string
Example
{
  "amount": "number (double)",
  "bulkUuid": "string",
  "created": "integer (int64)",
  "errorMessage": "string",
  "externalId": "string",
  "initiated": "integer (int64)",
  "internalId": "string",
  "owner": {
    "clientId": "string",
    "customerType": "string",
    "legalIdentifierAsLong": "integer (int64)",
    "name": "string",
    "simpleId": "integer (int64)",
    "uuid": "string"
  },
  "portfolioUuid": "string",
  "protocol": "string",
  "recurringTransactionDate": "string",
  "recurringTransactionId": "string",
  "status": "string",
  "subTransactions": [
    {
      "amount": "number (double)",
      "bulkUuid": "string",
      "created": "integer (int64)",
      "errorMessage": "string",
      "externalId": "string",
      "initiated": "integer (int64)",
      "internalId": "string",
      "owner": {
        "clientId": "string",
        "customerType": "string",
        "legalIdentifierAsLong": "integer (int64)",
        "name": "string",
        "simpleId": "integer (int64)",
        "uuid": "string"
      },
      "portfolioUuid": "string",
      "protocol": "string",
      "recurringTransactionDate": "string",
      "recurringTransactionId": "string",
      "status": "string",
      "subTransactions": [
        "#/definitions/Transaction"
      ],
      "targetAccount": {
        "accountNumber": "string",
        "autogiroPayerId": "integer (int64)",
        "autogiroStatus": "string",
        "bankIdentifier": "string",
        "clearingNumber": "string",
        "created": "string",
        "name": "string",
        "primary": "boolean",
        "signature": "string",
        "userUuid": "string",
        "uuid": "string"
      },
      "type": "string",
      "updated": "integer (int64)",
      "userUuid": "string",
      "uuid": "string"
    }
  ],
  "targetAccount": {
    "accountNumber": "string",
    "autogiroPayerId": "integer (int64)",
    "autogiroStatus": "string",
    "bankIdentifier": "string",
    "clearingNumber": "string",
    "created": "string",
    "name": "string",
    "primary": "boolean",
    "signature": "string",
    "userUuid": "string",
    "uuid": "string"
  },
  "type": "string",
  "updated": "integer (int64)",
  "userUuid": "string",
  "uuid": "string"
}

TransactionFilter: object

bulkId: string
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
internalId: string
maxDate: DateRepresentation
maxDateTime: string (date-time)
minDate: DateRepresentation
minDateTime: string (date-time)
protocolFilter: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
sortOrder: string DESC, ASC
sourceCode: string
statusFilter: string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
statusesFilter: string[]
string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
templatePortfolioIds: string[]
string
typeFilter: string[]
string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
Example
{
  "bulkId": "string",
  "clientId": "string",
  "internalId": "string",
  "maxDate": "string",
  "maxDateTime": "string (date-time)",
  "minDate": "string",
  "minDateTime": "string (date-time)",
  "protocolFilter": "string",
  "sortOrder": "string",
  "sourceCode": "string",
  "statusFilter": "string",
  "statusesFilter": [
    "string"
  ],
  "templatePortfolioIds": [
    "string"
  ],
  "typeFilter": [
    "string"
  ]
}

URI: object

absolute: boolean
authority: string
fragment: string
host: string
opaque: boolean
path: string
port: integer (int32)
query: string
rawAuthority: string
rawFragment: string
rawPath: string
rawQuery: string
rawSchemeSpecificPart: string
rawUserInfo: string
scheme: string
schemeSpecificPart: string
userInfo: string
Example
{
  "absolute": "boolean",
  "authority": "string",
  "fragment": "string",
  "host": "string",
  "opaque": "boolean",
  "path": "string",
  "port": "integer (int32)",
  "query": "string",
  "rawAuthority": "string",
  "rawFragment": "string",
  "rawPath": "string",
  "rawQuery": "string",
  "rawSchemeSpecificPart": "string",
  "rawUserInfo": "string",
  "scheme": "string",
  "schemeSpecificPart": "string",
  "userInfo": "string"
}

URL: object

authority: string
content: object
defaultPort: integer (int32)
file: string
host: string
path: string
port: integer (int32)
protocol: string
query: string
ref: string
userInfo: string
Example
{
  "authority": "string",
  "content": "object",
  "defaultPort": "integer (int32)",
  "file": "string",
  "host": "string",
  "path": "string",
  "port": "integer (int32)",
  "protocol": "string",
  "query": "string",
  "ref": "string",
  "userInfo": "string"
}

User: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdMigrationTarget: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdOriginal: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
deleted: string NOT_DELETED, PENDING, DELETED
email: string
firstName: string
idProvider: string bankid
lastName: string
newsletter: boolean
notifications: boolean
personalNumber: PersonalNumber
phone: string
premiumContact: ContactPerson
premiumLevel: string none, level_one
referrer: string
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
source: string
userProfileAlias: string
uuid: string
Example
{
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "idProvider": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "userProfileAlias": "string",
  "uuid": "string"
}

UserAccept: object

action: string test, autocopy, forum, welcome, intro
timestamp: DateTimeRepresentation
version: integer (int32)
Example
{
  "action": "string",
  "timestamp": "string",
  "version": "integer (int32)"
}

UserData: object

expires: integer (int64)
roles: string[]
string
subject: string
Example
{
  "expires": "integer (int64)",
  "roles": [
    "string"
  ],
  "subject": "string"
}

UserFilter: object

assetAmount: AssetAmount
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
maxAge: integer (int32)
maxAum: integer (int32)
minAge: integer (int32)
minAum: integer (int32)
newsletter: boolean
notifications: boolean
organizationFilter: string has_organizations, has_no_organizations
riskCategory: string low, medium, high, unknown
sortField: string CREATED, AUM, INVESTED, WITHDRAWN
sortOrder: string DESC, ASC
sourceCode: string
valueSource: PortfolioValueSource
Example
{
  "assetAmount": {
    "assetId": "string",
    "minAmount": "number (double)"
  },
  "clientId": "string",
  "maxAge": "integer (int32)",
  "maxAum": "integer (int32)",
  "minAge": "integer (int32)",
  "minAum": "integer (int32)",
  "newsletter": "boolean",
  "notifications": "boolean",
  "organizationFilter": "string",
  "riskCategory": "string",
  "sortField": "string",
  "sortOrder": "string",
  "sourceCode": "string",
  "valueSource": {
    "templateId": "string",
    "templateOwnerId": "string"
  }
}

UserKYC: object

responseItems: KYCResponseItem
KYCResponseItem
Example
{
  "responseItems": [
    {
      "hitRating": "integer (int32)",
      "itemType": "string",
      "listType": "string",
      "name": "string",
      "sourceName": "string"
    }
  ]
}

UserKnowledge: object

cashSources: object
citizenship: string[]
string SE, DK, FI, IS, NO, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
completedAcceptActions: UserAccept
UserAccept
completedKnowledgeTests: KnowledgeTest
KnowledgeTest
depositPeriodicity: string MONTHLY, MULTIPLE_PER_YEAR, YEARLY, OCCASIONALLY
employment: string EMPLOYED, SELF_EMPLOYED, UNEMPLOYED, PENSION, STUDENT, SICK_LEAVE, OTHER
funds: boolean
income: number (double)
investmentPurpose: object
investmentSize: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
liquidAssets: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
loansAndCredits: boolean
lossKnowledge: boolean
ownage: boolean
pep: string YES, NO, RELATED
pepPosition: string CHIEF_OF_STATE, MEMBER_OF_PARLAMENT, JUDGE, PUBLIC_COMPANY, AMBASSADOR_OR_OFFICER, AUDIT_AUTHORITY, CENTRAL_BANK_MEMBER_OF_BOARD, INTERNATIONAL_LEADER, PUBLIC_FUNCTION
pepRelation: string PARTNER, PARENT, CHILD, PARTNER_OF_CHILD, ASSISTANT, OTHER
pepRelationPosition: string CHIEF_OF_STATE, MEMBER_OF_PARLAMENT, JUDGE, PUBLIC_COMPANY, AMBASSADOR_OR_OFFICER, AUDIT_AUTHORITY, CENTRAL_BANK_MEMBER_OF_BOARD, INTERNATIONAL_LEADER, PUBLIC_FUNCTION
privacyPolicyAccept: TimestampedValue«boolean»
taxResidence: string SE, DK, FI, IS, NO, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
taxResidenceSweden: boolean
tin: string
transferSource: string SWE_BANK, SWE_INSURANCE, ESS
unrealizedLiquidAssets: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
version: integer (int32)
withdrawalPeriodicity: string MONTHLY, MULTIPLE_PER_YEAR, YEARLY, OCCASIONALLY
Example
{
  "cashSources": "object",
  "citizenship": [
    "string"
  ],
  "completedAcceptActions": [
    {
      "action": "string",
      "timestamp": "string",
      "version": "integer (int32)"
    }
  ],
  "completedKnowledgeTests": [
    {
      "completionDate": "string",
      "questions": [
        {
          "answerId": "string",
          "questionId": "string"
        }
      ],
      "type": "string",
      "version": "integer (int32)"
    }
  ],
  "depositPeriodicity": "string",
  "employment": "string",
  "funds": "boolean",
  "income": "number (double)",
  "investmentPurpose": "object",
  "investmentSize": "string",
  "liquidAssets": "string",
  "loansAndCredits": "boolean",
  "lossKnowledge": "boolean",
  "ownage": "boolean",
  "pep": "string",
  "pepPosition": "string",
  "pepRelation": "string",
  "pepRelationPosition": "string",
  "privacyPolicyAccept": {
    "updated": "string",
    "value": "boolean"
  },
  "taxResidence": "string",
  "taxResidenceSweden": "boolean",
  "tin": "string",
  "transferSource": "string",
  "unrealizedLiquidAssets": "string",
  "version": "integer (int32)",
  "withdrawalPeriodicity": "string"
}

UserKnowledgeAdminPatch: object

pep: FieldPatch«string»
pepPosition: FieldPatch«string»
pepRelation: FieldPatch«string»
pepRelationPosition: FieldPatch«string»
taxResidence: FieldPatch«string»
taxResidenceSweden: FieldPatch«boolean»
tin: FieldPatch«string»
Example
{
  "pep": {
    "action": "string",
    "value": "string"
  },
  "pepPosition": {
    "action": "string",
    "value": "string"
  },
  "pepRelation": {
    "action": "string",
    "value": "string"
  },
  "pepRelationPosition": {
    "action": "string",
    "value": "string"
  },
  "taxResidence": {
    "action": "string",
    "value": "string"
  },
  "taxResidenceSweden": {
    "action": "string",
    "value": "boolean"
  },
  "tin": {
    "action": "string",
    "value": "string"
  }
}

UserKnowledgeInformation: object

customerKnowledge: UserKnowledge
lastUpdated: DateTimeRepresentation
Example
{
  "customerKnowledge": {
    "cashSources": "object",
    "citizenship": [
      "string"
    ],
    "completedAcceptActions": [
      {
        "action": "string",
        "timestamp": "string",
        "version": "integer (int32)"
      }
    ],
    "completedKnowledgeTests": [
      {
        "completionDate": "string",
        "questions": [
          {
            "answerId": "string",
            "questionId": "string"
          }
        ],
        "type": "string",
        "version": "integer (int32)"
      }
    ],
    "depositPeriodicity": "string",
    "employment": "string",
    "funds": "boolean",
    "income": "number (double)",
    "investmentPurpose": "object",
    "investmentSize": "string",
    "liquidAssets": "string",
    "loansAndCredits": "boolean",
    "lossKnowledge": "boolean",
    "ownage": "boolean",
    "pep": "string",
    "pepPosition": "string",
    "pepRelation": "string",
    "pepRelationPosition": "string",
    "privacyPolicyAccept": {
      "updated": "string",
      "value": "boolean"
    },
    "taxResidence": "string",
    "taxResidenceSweden": "boolean",
    "tin": "string",
    "transferSource": "string",
    "unrealizedLiquidAssets": "string",
    "version": "integer (int32)",
    "withdrawalPeriodicity": "string"
  },
  "lastUpdated": "string"
}

UserMigrationResultItem: object

rowCount: integer (int32)
tableName: string
Example
{
  "rowCount": "integer (int32)",
  "tableName": "string"
}

UserNoteCreateData: object

note: string
Example
{
  "note": "string"
}

UserProfile: object

alias: string
description: string
facebookLink: string
id: string
instagramLink: string
linkedinLink: string
profilePicture: string
ticktockLink: string
topTraderData: TopTraderData
userUuid: string
verified: boolean
Example
{
  "alias": "string",
  "description": "string",
  "facebookLink": "string",
  "id": "string",
  "instagramLink": "string",
  "linkedinLink": "string",
  "profilePicture": "string",
  "ticktockLink": "string",
  "topTraderData": {
    "aumFraction": "number (double)",
    "depositFraction": "number (double)",
    "enabled": "boolean",
    "payoutMethod": "string"
  },
  "userUuid": "string",
  "verified": "boolean"
}

UserProfileAdminPatch: object

facebookLink: FieldPatch«string»
instagramLink: FieldPatch«string»
linkedinLink: FieldPatch«string»
profilePicture: FieldPatch«string»
tikTokLink: FieldPatch«string»
topTraderData: FieldPatch«TopTraderData»
verified: FieldPatch«boolean»
Example
{
  "facebookLink": {
    "action": "string",
    "value": "string"
  },
  "instagramLink": {
    "action": "string",
    "value": "string"
  },
  "linkedinLink": {
    "action": "string",
    "value": "string"
  },
  "profilePicture": {
    "action": "string",
    "value": "string"
  },
  "tikTokLink": {
    "action": "string",
    "value": "string"
  },
  "topTraderData": {
    "action": "string",
    "value": {
      "aumFraction": "number (double)",
      "depositFraction": "number (double)",
      "enabled": "boolean",
      "payoutMethod": "string"
    }
  },
  "verified": {
    "action": "string",
    "value": "boolean"
  }
}

UserStatistics: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
created: DateTimeRepresentation
deleted: boolean
portfolioCount: Decimal
recurringTransactionsCount: Decimal
totalPortfolioValue: Decimal
uuid: string
Example
{
  "clientId": "string",
  "created": "string",
  "deleted": "boolean",
  "portfolioCount": "number (double)",
  "recurringTransactionsCount": "number (double)",
  "totalPortfolioValue": "number (double)",
  "uuid": "string"
}

UserWithKYC: object

customerKnowledge: UserKnowledge
kyc: UserKYC
user: User
userId: string
Example
{
  "customerKnowledge": {
    "cashSources": "object",
    "citizenship": [
      "string"
    ],
    "completedAcceptActions": [
      {
        "action": "string",
        "timestamp": "string",
        "version": "integer (int32)"
      }
    ],
    "completedKnowledgeTests": [
      {
        "completionDate": "string",
        "questions": [
          {
            "answerId": "string",
            "questionId": "string"
          }
        ],
        "type": "string",
        "version": "integer (int32)"
      }
    ],
    "depositPeriodicity": "string",
    "employment": "string",
    "funds": "boolean",
    "income": "number (double)",
    "investmentPurpose": "object",
    "investmentSize": "string",
    "liquidAssets": "string",
    "loansAndCredits": "boolean",
    "lossKnowledge": "boolean",
    "ownage": "boolean",
    "pep": "string",
    "pepPosition": "string",
    "pepRelation": "string",
    "pepRelationPosition": "string",
    "privacyPolicyAccept": {
      "updated": "string",
      "value": "boolean"
    },
    "taxResidence": "string",
    "taxResidenceSweden": "boolean",
    "tin": "string",
    "transferSource": "string",
    "unrealizedLiquidAssets": "string",
    "version": "integer (int32)",
    "withdrawalPeriodicity": "string"
  },
  "kyc": {
    "responseItems": [
      {
        "hitRating": "integer (int32)",
        "itemType": "string",
        "listType": "string",
        "name": "string",
        "sourceName": "string"
      }
    ]
  },
  "user": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  },
  "userId": "string"
}

UserWithKnowledge: object

customerKnowledge: UserKnowledge
user: User
userId: string
Example
{
  "customerKnowledge": {
    "cashSources": "object",
    "citizenship": [
      "string"
    ],
    "completedAcceptActions": [
      {
        "action": "string",
        "timestamp": "string",
        "version": "integer (int32)"
      }
    ],
    "completedKnowledgeTests": [
      {
        "completionDate": "string",
        "questions": [
          {
            "answerId": "string",
            "questionId": "string"
          }
        ],
        "type": "string",
        "version": "integer (int32)"
      }
    ],
    "depositPeriodicity": "string",
    "employment": "string",
    "funds": "boolean",
    "income": "number (double)",
    "investmentPurpose": "object",
    "investmentSize": "string",
    "liquidAssets": "string",
    "loansAndCredits": "boolean",
    "lossKnowledge": "boolean",
    "ownage": "boolean",
    "pep": "string",
    "pepPosition": "string",
    "pepRelation": "string",
    "pepRelationPosition": "string",
    "privacyPolicyAccept": {
      "updated": "string",
      "value": "boolean"
    },
    "taxResidence": "string",
    "taxResidenceSweden": "boolean",
    "tin": "string",
    "transferSource": "string",
    "unrealizedLiquidAssets": "string",
    "version": "integer (int32)",
    "withdrawalPeriodicity": "string"
  },
  "user": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  },
  "userId": "string"
}

UserWithPensionDetails: object

pensionFlag: boolean
pensionPortfolio: boolean
user: User
Example
{
  "pensionFlag": "boolean",
  "pensionPortfolio": "boolean",
  "user": {
    "clientId": "string",
    "clientIdMigrationTarget": "string",
    "clientIdOriginal": "string",
    "confirmEmail": "string",
    "created": "string",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "idProvider": "string",
    "lastName": "string",
    "newsletter": "boolean",
    "notifications": "boolean",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    },
    "phone": "string",
    "premiumContact": {
      "email": "string",
      "imageUrl": "string",
      "name": "string",
      "phone": "string",
      "uuid": "string"
    },
    "premiumLevel": "string",
    "referrer": "string",
    "riskCategory": "string",
    "simpleId": "integer (int64)",
    "source": "string",
    "userProfileAlias": "string",
    "uuid": "string"
  }
}

UserWithRoles: object

authRoles: string[]
string
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdMigrationTarget: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdOriginal: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
deleted: string NOT_DELETED, PENDING, DELETED
email: string
features: string[]
string
firstName: string
idProvider: string bankid
lastName: string
newsletter: boolean
notifications: boolean
personalNumber: PersonalNumber
phone: string
premiumContact: ContactPerson
premiumLevel: string none, level_one
referrer: string
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
source: string
userProfileAlias: string
uuid: string
Example
{
  "authRoles": [
    "string"
  ],
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "features": [
    "string"
  ],
  "firstName": "string",
  "idProvider": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "userProfileAlias": "string",
  "uuid": "string"
}

UserWithValue: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdMigrationTarget: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdOriginal: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
deleted: string NOT_DELETED, PENDING, DELETED
email: string
firstName: string
idProvider: string bankid
investedValue: Decimal
lastName: string
newsletter: boolean
notifications: boolean
organizationsCount: Decimal
personalNumber: PersonalNumber
phone: string
premiumContact: ContactPerson
premiumLevel: string none, level_one
referrer: string
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
source: string
totalValue: Decimal
userProfileAlias: string
uuid: string
withdrawnValue: Decimal
Example
{
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "idProvider": "string",
  "investedValue": "number (double)",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "organizationsCount": "number (double)",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "totalValue": "number (double)",
  "userProfileAlias": "string",
  "uuid": "string",
  "withdrawnValue": "number (double)"
}

ValueAndDate«Decimal»: object

date: DateRepresentation
valid: boolean
value: Decimal
Example
{
  "date": "string",
  "valid": "boolean",
  "value": "number (double)"
}

ValueAndDate«Map«string,Decimal»»: object

date: DateRepresentation
valid: boolean
value: object
Example
{
  "date": "string",
  "valid": "boolean",
  "value": "object"
}

ValueAndDate«int»: object

date: DateRepresentation
valid: boolean
value: integer (int32)
Example
{
  "date": "string",
  "valid": "boolean",
  "value": "integer (int32)"
}

ValueCacheStatus: object

lastUpdate: integer (int64)
status: string MISSING, EXPIRED, INCOMPLETE, VALID
Example
{
  "lastUpdate": "integer (int64)",
  "status": "string"
}

Wallpaper: object

id: string
protocol: string standard
Example
{
  "id": "string",
  "protocol": "string"
}
Documentation by Spectacle