BetterWealth API API Reference
BetterWealth App API
API Endpoint
http://http://test.local/Terms of Service: Terms of service
Contact: api@betterwealth.se
Version: API 0.1
app-likes-resource
App Likes Resource
getLikes
likedIds
Request Content-Types: application/json
Request Example
[
"string"
]
unlike
payload
Request Content-Types: application/json
Request Example
{
"likedId": "string",
"type": "string"
}
200 OK
Delete a like
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"likedByUser": "boolean",
"likedId": "string",
"likes": "integer (int32)",
"type": "string"
}
like
payload
Request Content-Types: application/json
Request Example
{
"likedId": "string",
"type": "string"
}
200 OK
Create a like
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"likedByUser": "boolean",
"likedId": "string",
"likes": "integer (int32)",
"type": "string"
}
app-transactions-resource
App Transactions Resource
createAgTransaction
payload
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"bankAccountId": "string",
"orderEstimate": [
{
"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)"
}
],
"portfolioId": "string"
}
200 OK
The created deposit 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)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
createBgTransaction
payload
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"orderEstimate": [
{
"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)"
}
],
"portfolioId": "string"
}
200 OK
The created deposit 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)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
createSwishTransaction
payload
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"orderEstimate": [
{
"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)"
}
],
"portfolioId": "string"
}
200 OK
The created deposit 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)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
getInvoices
logIds
Request Content-Types: application/json
Request Example
[
"string"
]
200 OK
Invoices for requested log ids
type
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)"
}
]
getOngoingTransactions
200 OK
All ongoing transactions for customer
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"amount": "number (double)",
"bankAccountId": "string",
"cancelable": "boolean",
"id": "string",
"initiated": "string",
"lastUpdated": "string",
"portfolioId": "string",
"protocol": "string",
"status": "string",
"type": "string"
}
]
getPaymentReferences
200 OK
Payment references
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"bankGiro": "integer (int64)",
"portfolioId": "string",
"reference": "string"
}
]
getTransaction
transactionId:
string
in path
transactionId
200 OK
Get singe transaction for customer
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"amount": "number (double)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
deleteTransaction
transactionId:
string
in path
transactionId
200 OK
The cancelled transaction
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"amount": "number (double)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
deleteAgTransaction
transactionId:
string
in path
transactionId
200 OK
The cancelled transaction
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"amount": "number (double)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
cancelBgTransaction
transactionId:
string
in path
transactionId
200 OK
The cancelled transaction
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"amount": "number (double)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "string"
}
app-share-portfolio-resource
App Share Portfolio Resource
app-notification-resource
App Notification Resource
getDynamicNotifications
200 OK
Active dynamic notification generators
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"
}
}
]
getStaticNotifications
pageToken:
string
in query
pageToken
A page of generated 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)"
}
patchDynamicNotification
data
generatorId:
string
in path
generatorId
Request Content-Types: application/json
Request Example
{
"status": {
"action": "string",
"value": "string"
}
}
200 OK
Notification related to the generator
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
}
patchStaticNotification
data
notificationId:
string
in path
notificationId
Request Content-Types: application/json
Request Example
{
"status": {
"action": "string",
"value": "string"
}
}
200 OK
The updated notification
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
}
mailchimp-webhook-resource
Mailchimp Webhook Resource
confirmWebhook
200 OK
Response
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
getUpdate
body:
object
in formData
body
200 OK
Response
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: application/json
Response Example (200 OK)
{
"value": "string"
}
app-user-resource
App User Resource
updateUser
update
Request Content-Types: application/json
Request Example
{
"newsletter": {
"action": "string",
"value": "boolean"
},
"notifications": {
"action": "string",
"value": "boolean"
},
"phone": {
"action": "string",
"value": "string"
}
}
200 OK
The updated user
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"admin": {
"name": "string",
"uuid": "string"
},
"clientId": "string",
"clientIdMigrationTarget": "string",
"clientIdOriginal": "string",
"confirmEmail": "string",
"created": "string",
"email": "string",
"favorites": [
{
"created": "string",
"id": "string",
"type": "string"
}
],
"features": [
"string"
],
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"organization": {
"confirmEmail": "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"
}
},
"status": "string",
"users": [
{
"lastUpdated": "string",
"organizationId": "string",
"organizationRole": "string",
"userId": "string",
"userName": "string",
"uuid": "string"
}
],
"uuid": "string"
},
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "string"
}
getUser
200 OK
The currently authenticated user
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"admin": {
"name": "string",
"uuid": "string"
},
"clientId": "string",
"clientIdMigrationTarget": "string",
"clientIdOriginal": "string",
"confirmEmail": "string",
"created": "string",
"email": "string",
"favorites": [
{
"created": "string",
"id": "string",
"type": "string"
}
],
"features": [
"string"
],
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"organization": {
"confirmEmail": "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"
}
},
"status": "string",
"users": [
{
"lastUpdated": "string",
"organizationId": "string",
"organizationRole": "string",
"userId": "string",
"userName": "string",
"uuid": "string"
}
],
"uuid": "string"
},
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "string"
}
getCustomerAdvice
200 OK
Most recent advice to customer
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)"
},
"date": "string",
"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)"
}
getSignedDocuments
200 OK
Documents signed by user
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
]
getGroupedSignedDocuments
200 OK
Documents signed by user
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
]
getDocumentsForResignature
200 OK
Documents signed by user
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
]
updateEmail
update
version:
integer
(int32)
in query
version
Request Content-Types: application/json
Request Example
{
"email": "string"
}
200 OK
Confirmation of the updated email
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"email": "string"
}
updateEmail
confirmId:
string
in path
confirmId
200 OK
Confirmation of the updated email
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"email": "string"
}
createFavorite
data
Request Content-Types: application/json
Request Example
{
"created": "string",
"id": "string",
"type": "string"
}
200 OK
All favorites for the user
type
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",
"type": "string"
}
]
deleteFavorite
data
Request Content-Types: application/json
Request Example
{
"created": "string",
"id": "string",
"type": "string"
}
200 OK
All favorites for the user
type
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
[
{
"created": "string",
"id": "string",
"type": "string"
}
]
getCustomerKnowledge
200 OK
The requested user knowledge information
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"
}
updateCustomerKnowledge
update
Request Content-Types: application/json
Request Example
{
"cashSources": {
"action": "string",
"value": "object"
},
"citizenship": {
"action": "string",
"value": [
"string"
]
},
"completedKnowledgeTests": {
"action": "string",
"value": [
{
"questions": [
{
"answerId": "string",
"questionId": "string"
}
],
"type": "string",
"version": "integer (int32)"
}
]
},
"depositPeriodicity": {
"action": "string",
"value": "string"
},
"employment": {
"action": "string",
"value": "string"
},
"funds": {
"action": "string",
"value": "boolean"
},
"income": {
"action": "string",
"value": "number (double)"
},
"investmentPurpose": {
"action": "string",
"value": "object"
},
"investmentSize": {
"action": "string",
"value": "string"
},
"liquidAssets": {
"action": "string",
"value": "string"
},
"loansAndCredits": {
"action": "string",
"value": "boolean"
},
"lossKnowledge": {
"action": "string",
"value": "boolean"
},
"pep": {
"action": "string",
"value": "string"
},
"pepPosition": {
"action": "string",
"value": "string"
},
"pepRelation": {
"action": "string",
"value": "string"
},
"pepRelationPosition": {
"action": "string",
"value": "string"
},
"transferSource": {
"action": "string",
"value": "string"
},
"unrealizedLiquidAssets": {
"action": "string",
"value": "string"
},
"withdrawalPeriodicity": {
"action": "string",
"value": "string"
}
}
200 OK
The updated user knowledge information
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"
}
customerKnowledgeAccept
type:
string
in path
type
version:
integer
(int32)
in query
version
200 OK
Accept the given terms
201 Created
Created
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"
}
getUserLog
eventType:
string
in query
eventType
page:
integer
(int32)
0
in query
page
A page of log entries for customer
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"id": "string",
"timestamp": "integer (int64)",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
logoutUser
200 OK
Log out the current user
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
getUserProfile
200 OK
Current user 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"
}
createUserProfile
data
Request Content-Types: application/json
Request Example
{
"alias": {
"action": "string",
"value": "string"
},
"description": {
"action": "string",
"value": "string"
},
"facebookLink": {
"action": "string",
"value": "string"
},
"instagramLink": {
"action": "string",
"value": "string"
},
"linkedinLink": {
"action": "string",
"value": "string"
},
"tikTokLink": {
"action": "string",
"value": "string"
}
}
200 OK
The created user profile
201 Created
Created
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"
}
updateUserProfile
data
Request Content-Types: application/json
Request Example
{
"alias": {
"action": "string",
"value": "string"
},
"description": {
"action": "string",
"value": "string"
},
"facebookLink": {
"action": "string",
"value": "string"
},
"instagramLink": {
"action": "string",
"value": "string"
},
"linkedinLink": {
"action": "string",
"value": "string"
},
"tikTokLink": {
"action": "string",
"value": "string"
}
}
200 OK
The updated user 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"
}
getTaxReports
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)
200 OK
Tax report data for user
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
]
app-bank-id-login-resource
App Bank Id Login Resource
Initialize BankId login flow, poll ´/auth/poll´ for login progress.
bankIdInitRequest
Request Content-Types: application/json
Request Example
{
"allowedUnauthorized": "boolean",
"personalNumber": "string",
"requestType": "string"
}
200 OK
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"
}
handleBankIdAuthPollJson
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
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",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "string"
}
}
handleBankIdSignInit
bankIdInitRequest
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
{
"allowedUnauthorized": "boolean",
"personalNumber": "string",
"requestType": "string"
}
200 OK
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"
}
handleBankIdSignPollJson
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
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",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "string"
}
}
app-recommendations-resource
App Recommendations Resource
getRecommendations
entityId:
string
in path
entityId
source:
string
in query
source
200 OK
All recommendations for target entity
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"priority": "integer (int32)",
"source": "string",
"sourceId": "string",
"sourceType": "string",
"targetId": "string",
"targetType": "string"
}
]
app-investment-strategy-resource
App Investment Strategy Resource
getDefaultFees
bw-client-id:
string
in header
bw-client-id
200 OK
List of all default fees
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"
}
getDefaultFee
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
Default fee for 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"
}
app-portfolio-resource
App Portfolio Resource
getPortfolios
includeDeleted:
boolean
false
in query
includeDeleted
200 OK
All portfolios for customer
type
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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
]
createPortfolio
data
Request Content-Types: application/json
Request 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"
}
200 OK
The created 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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
getAccountNumbers
200 OK
Account number for all portfolios
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"accountNumber": "string"
}
]
getDocuments
goal
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
{
"bearLoss": "string",
"customTemplate": {
"type": "string"
},
"endDate": "string",
"goalAmount": "number (double)",
"id": "string",
"investmentPurpose": "string",
"maximalRisk": "number (float)",
"monthlyInvestment": "number (double)",
"monthlyPayout": "number (double)",
"name": "string",
"parent": "boolean",
"parentId": "string",
"payoutEndDate": "string",
"sri": "boolean",
"startInvestment": "number (double)",
"strategy": "string"
}
200 OK
List of signed documents for portfolio
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"goalId": "string",
"signableGroupId": {
"groupId": "string",
"groupType": "string",
"major": "integer (int32)",
"minor": "integer (int32)"
}
}
]
getPortfolioDistributions
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
The portfolio distributions, for all portfolios
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"assets": [
{
"amount": "number (double)",
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "number (double)",
"value": "number (double)"
}
]
}
]
getTotalValueHistory
200 OK
Historical values combined for all portfolios
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"dateTime": "string",
"value": "number (double)"
}
]
getPortfoliosLog
page:
integer
(int32)
in query
page
sort:
string
in query
sort
max_date:
string
in query
max_date
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 A page of portfolio log entries
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
getPortfoliosLog
filter
pageToken:
string
in query
pageToken
Request Content-Types: application/json
Request Example
{
"maxDate": "string",
"portfolios": [
"string"
],
"types": [
"string"
]
}
A page of portfolio log entries
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"nextToken": "string",
"size": "integer (int32)",
"token": "string",
"totalSize": "integer (int32)"
}
getPortfoliosTradeLog
assetId:
string
in path
assetId
pageToken:
string
in query
pageToken
A page of portfolio trade entries
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"amount": "number (double)",
"assetId": "string",
"currency": "string",
"currencyExchangeRate": "number (double)",
"currencyFee": "number (double)",
"marketplace": [
"string"
],
"portfolioId": "string",
"price": "number (double)",
"savedCurrencyFee": "number (double)",
"savedTradeFee": "number (double)",
"settlementTimestamp": "integer (int64)",
"timestamp": "integer (int64)",
"tradeFee": "number (double)",
"tradeOrderId": "string",
"tradedTimestamp": "integer (int64)",
"type": "string"
}
],
"first": "boolean",
"last": "boolean",
"nextToken": "string",
"size": "integer (int32)",
"token": "string",
"totalSize": "integer (int32)"
}
getPortfoliosTradeSummaryForAsset
assetId:
string
in path
assetId
200 OK
Summery of all trades for given asset
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"portfolios": [
{
"portfolioId": "string",
"summary": {
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
}
],
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
getPortfolioTradeOrders
filter
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"
}
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)"
}
getPortfolioTradeOrder
orderId:
string
in path
orderId
200 OK
Fetch a single portfolio trade order
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
getPortfolioValues
200 OK
Value for all portfolios
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"reservations": {
"feeAmount": "number (double)",
"settlementAmount": "number (double)",
"totalAmount": "number (double)",
"withdrawalAmount": "number (double)"
},
"reservedAmount": "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"
}
]
getPortfolio
portfolioId:
string
in path
portfolioId
200 OK
The requested 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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
deletePortfolio
portfolioId:
string
in path
portfolioId
200 OK
Response
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
updatePortfolio
portfolioId:
string
in path
portfolioId
Request Content-Types: application/json
Request Example
{
"endDate": {
"action": "string",
"value": "integer (int64)"
},
"goalAmount": {
"action": "string",
"value": "number (double)"
},
"investmentStrategyType": {
"action": "string",
"value": "string"
},
"maximalRisk": {
"action": "string",
"value": "number (float)"
},
"monthlyPayout": {
"action": "string",
"value": "number (double)"
},
"name": {
"action": "string",
"value": "string"
},
"payoutEndDate": {
"action": "string",
"value": "integer (int64)"
},
"templatePortfolioActionStatus": {
"action": "string",
"value": "string"
},
"wallpaper": {
"action": "string",
"value": {
"id": "string",
"protocol": "string"
}
}
}
200 OK
The updated portfolio
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
getAccountNumber
portfolioId:
string
in path
portfolioId
200 OK
Account number for portfolio
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"accountNumber": "string"
}
doInternalCashDeposit
portfolioId:
string
in path
portfolioId
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"orderEstimate": [
{
"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)"
}
],
"sourceId": "string",
"targetId": "string"
}
200 OK
Make an internal cash deposit into the specified 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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
cancelDeposit
portfolioId:
string
in path
portfolioId
200 OK
Cancel an ongoing deposit
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
getPortfolioDistribution
portfolioId:
string
in path
portfolioId
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
The requested portfolio distribution
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assets": [
{
"amount": "number (double)",
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "number (double)",
"value": "number (double)"
}
]
}
getAccruedFee
portfolioId:
string
in path
portfolioId
200 OK
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)"
}
getPeriodFee
portfolioId:
string
in path
portfolioId
200 OK
Fee for each day in the specified period
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"date": "string",
"feeAmount": "number (double)",
"feeFraction": "number (double)",
"portfolioValue": "number (double)"
}
]
getPortfolioAssetHistory
portfolioId:
string
in path
portfolioId
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
getPortfolioMarketReturnHistory
portfolioId:
string
in path
portfolioId
200 OK
Return values for portfolio (TWR)
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"dateTime": "string",
"value": "number (double)"
}
]
getPortfolioReturnHistory
portfolioId:
string
in path
portfolioId
200 OK
Return values for portfolio
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"dateTime": "string",
"value": "number (double)"
}
]
getPortfolioValueHistory
portfolioId:
string
in path
portfolioId
200 OK
Historical values for portfolio
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"dateTime": "string",
"value": "number (double)"
}
]
getISKReports
portfolioId:
string
in path
portfolioId
200 OK
List of isk tax reports generated for portfolio
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"deductedForeignTax": "number (double)",
"deposits": "number (double)",
"incomeMultiplier": "number (double)",
"iskIncome": "number (double)",
"portfolioId": "string",
"q1Initial": "number (double)",
"q2Initial": "number (double)",
"q3Initial": "number (double)",
"q4Initial": "number (double)",
"reportType": "string",
"year": "integer (int32)"
}
]
getPortfolioLog
portfolioId:
string
in path
portfolioId
page:
integer
(int32)
0
in query
page
sort:
string
in query
sort
max_date:
string
in query
max_date
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 A page of portfolio log entries
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
getPortfolioLog
filter
portfolioId:
string
in path
portfolioId
pageToken:
string
in query
pageToken
Request Content-Types: application/json
Request Example
{
"maxDate": "string",
"portfolios": [
"string"
],
"types": [
"string"
]
}
A page of portfolio log entries
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"nextToken": "string",
"size": "integer (int32)",
"token": "string",
"totalSize": "integer (int32)"
}
getPortfolioTradeSummaryForAsset
portfolioId:
string
in path
portfolioId
assetId:
string
in path
assetId
200 OK
Summery of all trades for given asset in a given portfolio
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
getPortfolioLogItem
portfolioId:
string
in path
portfolioId
logItemId:
string
in path
logItemId
The requested portfolio log item
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
getPortfolioTradeOrdersForPortfolio
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"
}
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)"
}
createTradeOrder
createData
portfolioId:
string
in path
portfolioId
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"assets": [
{
"amount": "number (double)",
"assetId": "string",
"tradeUnit": "string",
"value": "number (double)"
}
],
"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)"
}
],
"sourceId": "string",
"sourceType": "string",
"targetId": "string",
"targetType": "string",
"type": "string"
}
200 OK
The created trade order
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
createRecurringTradeOrder
createData
portfolioId:
string
in path
portfolioId
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"assets": [
{
"amount": "number (double)",
"assetId": "string",
"tradeUnit": "string",
"value": "number (double)"
}
],
"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)"
}
],
"sourceId": "string",
"sourceType": "string",
"targetId": "string",
"targetType": "string",
"transactionDay": "integer (int32)",
"type": "string"
}
The created recurring trade order
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)"
}
updateRecurringTradeOrder
patch
portfolioId:
string
in path
portfolioId
orderId:
string
in path
orderId
Request Content-Types: application/json
Request Example
{
"orderState": {
"action": "string",
"value": "string"
},
"transactionDay": {
"action": "string",
"value": "integer (int32)"
}
}
The updated recurring trade order
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
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)"
}
cancelPortfolioTradeOrder
portfolioId:
string
in path
portfolioId
orderId:
string
in path
orderId
200 OK
The updated trade order
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
triggerRealloc
portfolioId:
string
in path
portfolioId
200 OK
Manually trigger a relloc on portfolio
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
getPortfolioSignature
portfolioId:
string
in path
portfolioId
200 OK
Sign data for portfolio
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)"
},
"created": "integer (int64)",
"guide": "boolean",
"portfolioData": {
"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"
},
"recommendationStatus": "string",
"recommendedPortfolioData": {
"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"
}
}
getTemplatePortfolio
portfolioId:
string
in path
portfolioId
200 OK
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)
{
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
getPortfolioValue
portfolioId:
string
in path
portfolioId
200 OK
Value for portfolio
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"reservations": {
"feeAmount": "number (double)",
"settlementAmount": "number (double)",
"totalAmount": "number (double)",
"withdrawalAmount": "number (double)"
},
"reservedAmount": "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"
}
viewPortfolioAfterUpdate
portfolioId:
string
in path
portfolioId
Request Content-Types: application/json
Request Example
{
"endDate": {
"action": "string",
"value": "integer (int64)"
},
"goalAmount": {
"action": "string",
"value": "number (double)"
},
"investmentStrategyType": {
"action": "string",
"value": "string"
},
"maximalRisk": {
"action": "string",
"value": "number (float)"
},
"monthlyPayout": {
"action": "string",
"value": "number (double)"
},
"name": {
"action": "string",
"value": "string"
},
"payoutEndDate": {
"action": "string",
"value": "integer (int64)"
},
"templatePortfolioActionStatus": {
"action": "string",
"value": "string"
},
"wallpaper": {
"action": "string",
"value": {
"id": "string",
"protocol": "string"
}
}
}
200 OK
The portfolio as it would look if the update was applied
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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
doInternalWithdrawal
portfolioId:
string
in path
portfolioId
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"fullWithdrawal": "boolean",
"orderEstimate": [
{
"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)"
}
],
"sourceId": "string",
"targetId": "string"
}
200 OK
Make an internal withdrawal, sell assets from one portfolio and put the generated cash in an other
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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
cancelWithdrawal
portfolioId:
string
in path
portfolioId
200 OK
Cancel an ongoing withdrawal
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
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",
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
}
app-onboarding-resource
App Onboarding Resource
getDefaultFees
bw-client-id:
string
in header
bw-client-id
200 OK
List of all default fees
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"
}
getDocuments
goals
Request Content-Types: application/json
Request Example
[
{
"bearLoss": "string",
"customTemplate": {
"type": "string"
},
"endDate": "string",
"goalAmount": "number (double)",
"id": "string",
"investmentPurpose": "string",
"maximalRisk": "number (float)",
"monthlyInvestment": "number (double)",
"monthlyPayout": "number (double)",
"name": "string",
"parent": "boolean",
"parentId": "string",
"payoutEndDate": "string",
"sri": "boolean",
"startInvestment": "number (double)",
"strategy": "string"
}
]
200 OK
Documents that needs signing to create the given investments
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"goalId": "string",
"signableGroupId": {
"groupId": "string",
"groupType": "string",
"major": "integer (int32)",
"minor": "integer (int32)"
}
}
]
getSignUpDocumentsForOrg
200 OK
Documents in need of signing for an organization onboarding
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
}
]
getKnowledgeData
User knowledge data
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"cashSourceOptions": [
{
"title": "string",
"value": "string"
}
],
"depositPeriodicityOptions": [
{
"title": "string",
"value": "string"
}
],
"employmentOptions": [
{
"title": "string",
"value": "string"
}
],
"investmentPurposeOptions": [
{
"title": "string",
"value": "string"
}
],
"investmentSizeOptions": [
{
"title": "string",
"value": "string"
}
],
"pepPositionOptions": [
{
"title": "string",
"value": "string"
}
],
"pepRelationOptions": [
{
"title": "string",
"value": "string"
}
],
"transferSourceOptions": [
{
"title": "string",
"value": "string"
}
],
"withdrawalPeriodicityOptions": [
{
"title": "string",
"value": "string"
}
]
}
getOrganizationKnowledgeData
Organization knowledge data
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"cashSourceOptions": [
{
"title": "string",
"value": "string"
}
],
"investmentSizeOptions": [
{
"title": "string",
"value": "string"
}
]
}
create
createData
Request Content-Types: application/json
Request Example
{
"email": "string",
"goalStrategy": "string",
"name": "string",
"newsletter": "boolean",
"onboarding": "boolean",
"pensionPlan": "boolean",
"phone": "string",
"portfolioStrategy": "string",
"privacyPolicyAcceptVersion": "integer (int32)",
"tags": [
"string"
]
}
200 OK
Reponse
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
getRecommendedGoals
configuration
Request Content-Types: application/json
Request Example
{
"accountType": "string",
"age": "integer (int32)",
"bearLoss": "string",
"income": "integer (int32)",
"monthlyInvestment": "integer (int32)",
"retirementConfiguration": {
"payoutAmount": "integer (int32)",
"payoutEndAge": "integer (int32)",
"payoutStartAge": "integer (int32)"
},
"selectedInvestments": [
"string"
],
"sri": "boolean",
"startInvestment": "integer (int32)",
"timeHorizon": "integer (int32)"
}
200 OK
Recommended investment goals for given configuration
type
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"bearLoss": "string",
"customTemplate": {
"type": "string"
},
"endDate": "string",
"goalAmount": "number (double)",
"id": "string",
"investmentPurpose": "string",
"maximalRisk": "number (float)",
"monthlyInvestment": "number (double)",
"monthlyPayout": "number (double)",
"name": "string",
"parent": "boolean",
"parentId": "string",
"payoutEndDate": "string",
"sri": "boolean",
"startInvestment": "number (double)",
"strategy": "string"
}
]
getRecommendedInvestmentTypes
configuration
Request Content-Types: application/json
Request Example
{
"accountType": "string",
"age": "integer (int32)",
"bearLoss": "string",
"income": "integer (int32)",
"monthlyInvestment": "integer (int32)",
"sri": "boolean",
"startInvestment": "integer (int32)",
"strategy": "string",
"timeHorizon": "integer (int32)"
}
200 OK
Recommended investment types for given configuration
type
string[]
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
"string"
]
getStrategy
Request Content-Types: application/json
Request Example
{
"sri": "boolean",
"strategyType": "string"
}
Investment strategy data
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"dataRepresentations": [
{
"defaultFee": "number (double)",
"estimatedReturn": "number (double)",
"piOneMonth": "number (double)",
"piOneYear": "number (double)",
"sig2OneMonth": "number (double)",
"sigOneMonth": "number (double)",
"sigOneYear": "number (double)",
"strategyIndex": "string",
"targetDistribution": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"templateId": "string",
"volatility": "number (double)"
}
],
"defaultFee": {
"fixedTradeFee": {
"exchangeFee": "number (double)",
"tradeFee": "number (double)"
},
"managementFee": "number (double)",
"noValueBasedDiscount": "boolean",
"safekeepingFee": "number (double)",
"tradeFeesNotIncluded": "boolean",
"valueBasedDiscount": "number (double)",
"vat": "number (double)"
},
"rule": "object"
}
getTemplatePortfolioByIndex
strategy_index:
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
in query
strategy_index
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
Template portfolio for given strategy index
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
getTemplatePortfolio
templatePortfolioId:
string
in path
templatePortfolioId
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
Template portfolio
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
getTemplatePortfolioHistory
templatePortfolioId:
string
in path
templatePortfolioId
200 OK
History for template portfolio
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"dateTime": "string",
"value": "number (double)"
}
]
app-shared-portfolio-resource
App Shared Portfolio Resource
app-asset-public-resource
App Asset Public Resource
getAssets
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
All active assets
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
}
]
getAssets
assetIds
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
Request Content-Types: application/json
Request Example
[
"string"
]
200 OK
Assets
type
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
}
]
getCashAsset
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
Cash asset
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
}
getCurrencyExchangeRates
baseCurrency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in path
baseCurrency
Get currency exchange rate values
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)"
}
]
}
getDefaultAsset
200 OK
Default currency for client
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
}
queryAssets
filter
bw-client-id:
string
in header
bw-client-id
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
Query for active assets
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "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)"
}
queryAssetTypes
filter
bw-client-id:
string
in header
bw-client-id
Request Content-Types: application/json
Request Example
{
"clientId": "string",
"investmentStrategyType": "string"
}
200 OK
Get supported asset types
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "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)"
}
getAsset
assetId:
string
in path
assetId
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
Asset data
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
}
getAssetDividendHistory
assetId:
string
in path
assetId
startDate:
string
in query
startDate
endDate:
string
in query
endDate
200 OK
Historical dividends for asset
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"amountPerShare": "number (double)",
"assetId": "string",
"currency": "string",
"currencyExchangeRate": "number (double)",
"deductedTaxFraction": "number (double)",
"dividendType": "string",
"exDate": "string",
"message": "string",
"payoutDate": "string",
"title": "string"
}
]
getAssetValueHistory
assetId:
string
in path
assetId
startDate:
string
in query
startDate
endDate:
string
in query
endDate
200 OK
Historical values for asset
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)"
}
]
}
app-organizations-resource
App Organizations Resource
getConnectedOrganizations
200 OK
List of organizations
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"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"
}
},
"status": "string",
"uuid": "string"
}
]
updateEmail
update
Request Content-Types: application/json
Request Example
{
"email": "string"
}
200 OK
Response
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
getOrganizationKnowledge
200 OK
The requested organization knowledge
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)"
}
updateOrganizationKnowledge
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
The updated organization knowledge
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)"
}
authToOrg
orgId:
string
in path
orgId
200 OK
The requested organization
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"confirmEmail": "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"
}
},
"status": "string",
"users": [
{
"lastUpdated": "string",
"organizationId": "string",
"organizationRole": "string",
"userId": "string",
"userName": "string",
"uuid": "string"
}
],
"uuid": "string"
}
app-action-code-public-resource
App Action Code Public Resource
getCodeByName
code:
string
in path
code
200 OK
The action code
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
app-confirm-resource
App Confirm Resource
confirmEmail
confirmId:
string
in path
confirmId
200 OK
Response
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
app-bank-account-resource
App Bank Account Resource
getBankAccount
200 OK
Customer's bank accounts
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
}
]
getDocuments
200 OK
Documents in need of signing
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
}
]
getBankOptions
validateAccount
bankAccount
Request Content-Types: application/json
Request Example
{
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
}
200 OK
Validation response
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"success": "boolean"
}
deleteBankAccount
accountId:
string
in path
accountId
200 OK
Response
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
updateBankAccount
patch
accountId:
string
in path
accountId
Request Content-Types: application/json
Request Example
{
"name": {
"action": "string",
"value": "string"
}
}
200 OK
The updated bank account
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
}
cancel
accountId:
string
in path
accountId
200 OK
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",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
}
setPrimaryAccount
accountId:
string
in path
accountId
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)
200 OK
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",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
}
app-asset-resource
App Asset Resource
getAssetReplacements
200 OK
List of asset replacement items, used to properly format sales reports
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"originalId": "string",
"originalTicker": "string",
"replacementId": "string"
}
]
getAssetValueHistory
assetId:
string
in path
assetId
startDate:
string
in query
startDate
endDate:
string
in query
endDate
200 OK
Historical values for asset
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)"
}
]
}
app-action-code-resource
App Action Code Resource
getActivationsForCustomer
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)
200 OK
All activations made by customer
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"action": "string",
"actionProps": {
"initialValue": "number (double)"
},
"activated": "string",
"codeId": "string",
"description": "string",
"id": "string",
"name": "string",
"role": "string",
"type": "string",
"value": "number (double)"
}
]
getAllActivationsForCustomer
pageToken:
string
in query
pageToken
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)
All activations of customer codes (activated and issued)
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"content": [
{
"activated": "string",
"codeId": "string",
"converted": "string",
"fullyConverted": "boolean",
"id": "string"
}
],
"first": "boolean",
"last": "boolean",
"nextToken": "string",
"size": "integer (int32)",
"token": "string",
"totalSize": "integer (int32)"
}
issueReferralCode
200 OK
The issued action code
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
issueProReferralCode
200 OK
The issued action code
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"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"
}
activateCode
code:
string
in path
code
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)
200 OK
The generated code activation
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"action": "string",
"actionProps": {
"initialValue": "number (double)"
},
"activated": "string",
"codeId": "string",
"description": "string",
"id": "string",
"name": "string",
"role": "string",
"type": "string",
"value": "number (double)"
}
app-template-portfolio-resource
App Template Portfolio Resource
getTemplatePortfolio
templatePortfolioId:
string
in path
templatePortfolioId
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
The requested template portfolio
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
app-custom-template-portfolio-resource
App Custom Template Portfolio Resource
createTemplatePortfolio
Request Content-Types: application/json
Request Example
{
"distribution": {
"action": "string",
"value": [
{
"assetId": "string",
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string"
}
]
},
"name": {
"action": "string",
"value": "string"
}
}
200 OK
The create custom template portfolio
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"accessibility": "string",
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"ownerId": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"ter": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
getTemplatePortfolio
templatePortfolioId:
string
in path
templatePortfolioId
currency:
string
CHF,
EUR,
GBP,
GBX,
JPY,
SEK,
USD
in query
currency
200 OK
The requested custom template portfolio
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"accessibility": "string",
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"ownerId": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"ter": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
updateTemplatePortfolio
templatePortfolioId:
string
in path
templatePortfolioId
Request Content-Types: application/json
Request Example
{
"forceRealloc": "boolean",
"orderEstimate": [
{
"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)"
}
],
"patch": {
"distribution": {
"action": "string",
"value": [
{
"assetId": "string",
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string"
}
]
},
"name": {
"action": "string",
"value": "string"
}
}
}
200 OK
The updated custom template portfolio
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"accessibility": "string",
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"ownerId": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"ter": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
getTemplatePortfolioMeta
templatePortfolioId:
string
in path
templatePortfolioId
200 OK
Custom template portfolio meta
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assetTypes": [
"string"
],
"categories": [
"string"
],
"description": "string",
"grade": "integer (int32)",
"name": "string",
"sri": "boolean",
"status": {
"level": "string",
"trigger": "string"
}
}
createTemplatePortfolioMeta
templatePortfolioId:
string
in path
templatePortfolioId
Request Content-Types: application/json
Request Example
{
"assetTypes": {
"action": "string",
"value": [
"string"
]
},
"categories": {
"action": "string",
"value": [
"string"
]
},
"description": {
"action": "string",
"value": "string"
},
"name": {
"action": "string",
"value": "string"
}
}
200 OK
The created custom template portfolio meta
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"assetTypes": [
"string"
],
"categories": [
"string"
],
"description": "string",
"grade": "integer (int32)",
"name": "string",
"sri": "boolean",
"status": {
"level": "string",
"trigger": "string"
}
}
updateTemplatePortfolioMeta
templatePortfolioId:
string
in path
templatePortfolioId
Request Content-Types: application/json
Request Example
{
"assetTypes": {
"action": "string",
"value": [
"string"
]
},
"categories": {
"action": "string",
"value": [
"string"
]
},
"description": {
"action": "string",
"value": "string"
},
"name": {
"action": "string",
"value": "string"
}
}
200 OK
The updated custom template portfolio meta
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"assetTypes": [
"string"
],
"categories": [
"string"
],
"description": "string",
"grade": "integer (int32)",
"name": "string",
"sri": "boolean",
"status": {
"level": "string",
"trigger": "string"
}
}
triggerCustomTemplateRealloc
templatePortfolioId:
string
in path
templatePortfolioId
200 OK
A result object
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
triggerCustomTemplateRealloc
templatePortfolioId:
string
in path
templatePortfolioId
portfolioId:
string
in path
portfolioId
200 OK
A result object
201 Created
Created
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
app-risk-factor-resource
App Risk Factor Resource
getReturn
riskFactor:
string
in path
riskFactor
target_currency:
string
SEK
in query
target_currency
200 OK
Historical values for risk factor
type
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
[
{
"dateTime": "string",
"value": "number (double)"
}
]
healthz-resource
Healthz Resource
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"
app-document-resource
App Document Resource
getCapitalAdequacyReport
disposition:
string
in query
disposition
200 OK
Download the capital adequacy report
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"
}
}
getDocument
documentId:
string
in path
documentId
disposition:
string
in query
disposition
200 OK
Download 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"
}
}
app-recurring-transactions-resource
App Recurring Transactions Resource
getActive
200 OK
All active recurring transactions
type
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",
"transactionDay": "integer (int32)",
"type": "string",
"uuid": "string"
}
]
createRecurringTransaction
Request Content-Types: application/json
Request Example
{
"amount": "number (double)",
"bankAccountId": "string",
"portfolioIndex": "integer (int32)",
"transactionDay": "integer (int32)",
"type": "string"
}
200 OK
The updated recurring 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)",
"bankAccountId": "string",
"created": "string",
"paused": "boolean",
"portfolioIndex": "integer (int32)",
"protocol": "string",
"transactionDay": "integer (int32)",
"type": "string",
"uuid": "string"
}
patch
transactionId:
string
in path
transactionId
Request Content-Types: application/json
Request Example
{
"amount": {
"action": "string",
"value": "number (double)"
},
"bankAccount": {
"action": "string",
"value": "string"
},
"paused": {
"action": "string",
"value": "boolean"
}
}
200 OK
The updated recurring transaction
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"amount": "number (double)",
"bankAccountId": "string",
"created": "string",
"paused": "boolean",
"portfolioIndex": "integer (int32)",
"protocol": "string",
"transactionDay": "integer (int32)",
"type": "string",
"uuid": "string"
}
delete
transactionId:
string
in path
transactionId
200 OK
Response
204 No Content
No Content
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
app-dummy-resource
App Dummy Resource
dummy
200 OK
Response
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not Found
Response Content-Types: */*
Response Example (200 OK)
{
"value": "string"
}
Schema Definitions
AGTransactionCreatePayload: object
- amount: Decimal
- bankAccountId: string
- orderEstimate: OrderEstimateItem
-
OrderEstimateItem - portfolioId: string
Example
{
"amount": "number (double)",
"bankAccountId": "string",
"orderEstimate": [
{
"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)"
}
],
"portfolioId": "string"
}
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"
}
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)"
}
ActionProps: object
- initialValue: Decimal
Example
{
"initialValue": "number (double)"
}
Asset: object
- 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
- category: string
- ceo: string
- comments: string
- country: string
- currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
- currencyAllocation: object
- currencyAllocationDate: DateRepresentation
- currencyExchangeFeeDisabled: boolean
- description: string
- dividend: boolean
- 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
- isActivePlatform: 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
- numEmployees: integer (int32)
- numberOfHoldings: integer (int32)
- numberOfHoldingsDate: DateRepresentation
- 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
- sri: boolean
- strategyDescription: string
- ter: Decimal
- ticker: string
- tradeFeeDisabled: boolean
- tradeStopped: boolean
- type: string ETF, ETF_TEMP, CASH, STOCK, FUND
- ucits: boolean
- url: string
- value: AssetValue
Example
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
}
AssetBaseValue: object
- lastClosing: Decimal
- lastClosingDate: DateRepresentation
Example
{
"lastClosing": "number (double)",
"lastClosingDate": "string"
}
AssetDividend: object
- amountPerShare: Decimal
- assetId: string
- currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
- currencyExchangeRate: Decimal
- deductedTaxFraction: Decimal
- dividendType: string DIVIDEND, SUBSCRIPTION_RIGHTS, OTHER
- exDate: DateRepresentation
- message: string
- payoutDate: DateRepresentation
- title: string
Example
{
"amountPerShare": "number (double)",
"assetId": "string",
"currency": "string",
"currencyExchangeRate": "number (double)",
"deductedTaxFraction": "number (double)",
"dividendType": "string",
"exDate": "string",
"message": "string",
"payoutDate": "string",
"title": "string"
}
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"
]
}
AssetReplacement: object
- originalId: string
- originalTicker: string
- replacementId: string
Example
{
"originalId": "string",
"originalTicker": "string",
"replacementId": "string"
}
AssetTypeFilter: object
- clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
- 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
{
"clientId": "string",
"investmentStrategyType": "string"
}
AssetValue: object
- currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
- fiveYears: Decimal
- last: Decimal
- lastClosing: Decimal
- lastClosingDate: DateRepresentation
- lastPeriodUpdate: DateRepresentation
- lastValueUpdated: DateTimeRepresentation
- oneMonth: Decimal
- oneYear: Decimal
- sixMonths: Decimal
- thisYear: Decimal
- threeMonths: Decimal
- threeYears: Decimal
Example
{
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
BGTransactionCreatePayload: object
- amount: Decimal
- orderEstimate: OrderEstimateItem
-
OrderEstimateItem - portfolioId: string
Example
{
"amount": "number (double)",
"orderEstimate": [
{
"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)"
}
],
"portfolioId": "string"
}
BankAccount: object
- accountNumber: string
- 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
- name: string
- primary: boolean
- signature: string
- userUuid: string
- uuid: string
Example
{
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
}
BankAccountPatch: object
- name: FieldPatch«string»
Example
{
"name": {
"action": "string",
"value": "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"
}
BankIdPollResponse: object
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",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "string"
}
}
BwDocument: object
- category: string PRE_SALES_AGREEMENT, INVESTMENT_INSTRUCTION, AGREEMENT_CUSTOMER, AGREEMENT_ACCOUNT, AGREEMENT_OTHER, CAPITAL_ADEQUACY_REPORT, OTHER
- contentType: string
- documentId: string
- documentUrl: string
- hash: string
- title: string
- type: string PORTFOLIO, GENERIC
Example
{
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
}
BwDocumentResignGroup: object
- documents: BwDocument
-
BwDocument - entityId: string
- groupId: string
- parentId: string
- signableGroupId: SignableGroupId
Example
{
"documents": [
{
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
}
],
"entityId": "string",
"groupId": "string",
"parentId": "string",
"signableGroupId": {
"groupId": "string",
"groupType": "string",
"major": "integer (int32)",
"minor": "integer (int32)"
}
}
BwDocumentResignGroups: object
- documents: BwDocumentResignGroup
-
BwDocumentResignGroup
Example
{
"documents": [
{
"documents": [
{
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
}
],
"entityId": "string",
"groupId": "string",
"parentId": "string",
"signableGroupId": {
"groupId": "string",
"groupType": "string",
"major": "integer (int32)",
"minor": "integer (int32)"
}
}
]
}
BwSignedDocument: object
- document: BwDocument
- groupIdentifier: BwSignedDocumentGroupIdentifier
- signatureId: string
- signedDate: DateTimeRepresentation
Example
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
BwSignedDocumentGroupIdentifier: object
- documentGroupId: string
- documentGroupType: string SIGN_UP, AUTO_GIRO, ADD_PORTFOLIO, ADD_PENSION_INSURANCE, SIGN_UP_ORG, ADD_ENTITY_DEPOT_PORTFOLIO
- documentGroupVersion: DocumentGroupVersion
- parentId: string
Example
{
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
}
CodeConversionMetric: object
- activated: DateTimeRepresentation
- codeId: string
- converted: DateTimeRepresentation
- fullyConverted: boolean
- id: string
Example
{
"activated": "string",
"codeId": "string",
"converted": "string",
"fullyConverted": "boolean",
"id": "string"
}
CompletedTradeItem: object
- amount: Decimal
- assetId: string
- currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
- currencyExchangeRate: Decimal
- currencyFee: Decimal
- marketplace: string[]
-
string - portfolioId: string
- price: Decimal
- savedCurrencyFee: Decimal
- savedTradeFee: Decimal
- settlementTimestamp: integer (int64)
- timestamp: integer (int64)
- tradeFee: Decimal
- 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"
],
"portfolioId": "string",
"price": "number (double)",
"savedCurrencyFee": "number (double)",
"savedTradeFee": "number (double)",
"settlementTimestamp": "integer (int64)",
"timestamp": "integer (int64)",
"tradeFee": "number (double)",
"tradeOrderId": "string",
"tradedTimestamp": "integer (int64)",
"type": "string"
}
CreateData: object
- email: string
- goalStrategy: string NOT_SET, UNKNOWN, BUFFER, RETIREMENT, GENERAL, PENSION
- name: string
- newsletter: boolean
- onboarding: boolean
- pensionPlan: boolean
- phone: string
- portfolioStrategy: string NOT_SET, UNKNOWN, DYNAMIC, STATIC
- privacyPolicyAcceptVersion: integer (int32)
- tags: string[]
-
string
Example
{
"email": "string",
"goalStrategy": "string",
"name": "string",
"newsletter": "boolean",
"onboarding": "boolean",
"pensionPlan": "boolean",
"phone": "string",
"portfolioStrategy": "string",
"privacyPolicyAcceptVersion": "integer (int32)",
"tags": [
"string"
]
}
CurrencyExchangeRate: object
- currency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
- timestamp: DateTimeRepresentation
- value: Decimal
Example
{
"currency": "string",
"timestamp": "string",
"value": "number (double)"
}
CurrencyExchangeRates: object
- baseCurrency: string CHF, EUR, GBP, GBX, JPY, SEK, USD
- currencyExchangeRates: CurrencyExchangeRate
-
CurrencyExchangeRate
Example
{
"baseCurrency": "string",
"currencyExchangeRates": [
{
"currency": "string",
"timestamp": "string",
"value": "number (double)"
}
]
}
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)"
}
CustomTemplatePortfolio: object
- accessibility: string private, public, delisted
- assets: TemplatePortfolioDistributionPart
-
TemplatePortfolioDistributionPart - estimatedReturn: number (double)
- id: string
- lastDistributionChange: integer (int64)
- maxDD: number (double)
- name: string
- ownerId: string
- sri: boolean
- 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
- target: TargetDistribution
- targetVar: number (double)
- ter: Decimal
- var: number (double)
- volatility: number (double)
Example
{
"accessibility": "string",
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"ownerId": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"ter": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
CustomTemplatePortfolioCreateData: object
- assetTypes: FieldPatch«List«string»»
- categories: FieldPatch«List«string»»
- description: FieldPatch«string»
- name: FieldPatch«string»
Example
{
"assetTypes": {
"action": "string",
"value": [
"string"
]
},
"categories": {
"action": "string",
"value": [
"string"
]
},
"description": {
"action": "string",
"value": "string"
},
"name": {
"action": "string",
"value": "string"
}
}
CustomTemplatePortfolioFilter: object
- 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
- searchQuery: string
- templateIds: string[]
-
string
Example
{
"category": [
"string"
],
"invertOrder": "boolean",
"order": "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
- sri: boolean
- status: SharedPortfolioStatus
Example
{
"assetTypes": [
"string"
],
"categories": [
"string"
],
"description": "string",
"grade": "integer (int32)",
"name": "string",
"sri": "boolean",
"status": {
"level": "string",
"trigger": "string"
}
}
CustomTemplatePortfolioMetaPatch: object
- assetTypes: FieldPatch«List«string»»
- categories: FieldPatch«List«string»»
- description: FieldPatch«string»
- name: FieldPatch«string»
Example
{
"assetTypes": {
"action": "string",
"value": [
"string"
]
},
"categories": {
"action": "string",
"value": [
"string"
]
},
"description": {
"action": "string",
"value": "string"
},
"name": {
"action": "string",
"value": "string"
}
}
CustomTemplatePortfolioPart: object
Example
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string",
"savedFraction": "number (double)"
}
CustomTemplatePortfolioPatch: object
- distribution: FieldPatch«List«CustomTemplatePortfolioPatchPart»»
- name: FieldPatch«string»
Example
{
"distribution": {
"action": "string",
"value": [
{
"assetId": "string",
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string"
}
]
},
"name": {
"action": "string",
"value": "string"
}
}
CustomTemplatePortfolioPatchPart: object
- assetId: string
- fraction: Decimal
- partType: string ASSET, RISK_FACTOR
- riskFactorId: string
Example
{
"assetId": "string",
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string"
}
CustomTemplatePortfolioUpdate: object
- forceRealloc: boolean
- orderEstimate: OrderEstimateItem
-
OrderEstimateItem - patch: CustomTemplatePortfolioPatch
Example
{
"forceRealloc": "boolean",
"orderEstimate": [
{
"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)"
}
],
"patch": {
"distribution": {
"action": "string",
"value": [
{
"assetId": "string",
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string"
}
]
},
"name": {
"action": "string",
"value": "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
- date: DateTimeRepresentation
- 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)"
},
"date": "string",
"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)"
}
CustomerKnowledgeInformation: 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"
}
CustomerLogItem: object
- id: string
- timestamp: integer (int64)
- userId: string
Example
{
"id": "string",
"timestamp": "integer (int64)",
"userId": "string"
}
DailyFee: object
- date: DateRepresentation
- feeAmount: Decimal
- feeFraction: Decimal
- portfolioValue: Decimal
Example
{
"date": "string",
"feeAmount": "number (double)",
"feeFraction": "number (double)",
"portfolioValue": "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"
}
DocumentGroupVersion: object
- major: integer (int32)
- minor: integer (int32)
Example
{
"major": "integer (int32)",
"minor": "integer (int32)"
}
External: object
- documents: BwSignedDocument
-
BwSignedDocument - email: string
- entityId: string
- groupIdentifier: BwSignedDocumentGroupIdentifier
- id: string
- imageUrl: string
- name: string
- phone: string
- prevVersion: External
- resignRequired: boolean
- signedDate: DateTimeRepresentation
Example
{
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"resignRequired": "boolean",
"signedDate": "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)"
}
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"
}
FieldPatch«Decimal»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: Decimal
Example
{
"action": "string",
"value": "number (double)"
}
FieldPatch«List«CustomTemplatePortfolioPatchPart»»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: CustomTemplatePortfolioPatchPart
-
CustomTemplatePortfolioPatchPart
Example
{
"action": "string",
"value": [
{
"assetId": "string",
"fraction": "number (double)",
"partType": "string",
"riskFactorId": "string"
}
]
}
FieldPatch«List«KnowledgeTestCompletion»»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: KnowledgeTestCompletion
-
KnowledgeTestCompletion
Example
{
"action": "string",
"value": [
{
"questions": [
{
"answerId": "string",
"questionId": "string"
}
],
"type": "string",
"version": "integer (int32)"
}
]
}
FieldPatch«List«string»»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: 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
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«Set«string»»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: 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
Example
{
"action": "string",
"value": [
"string"
]
}
FieldPatch«Wallpaper»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: Wallpaper
Example
{
"action": "string",
"value": {
"id": "string",
"protocol": "string"
}
}
FieldPatch«boolean»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: boolean
Example
{
"action": "string",
"value": "boolean"
}
FieldPatch«double»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: number (double)
Example
{
"action": "string",
"value": "number (double)"
}
FieldPatch«float»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: number (float)
Example
{
"action": "string",
"value": "number (float)"
}
FieldPatch«int»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: integer (int32)
Example
{
"action": "string",
"value": "integer (int32)"
}
FieldPatch«long»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: integer (int64)
Example
{
"action": "string",
"value": "integer (int64)"
}
FieldPatch«string»: object
- action: string NONE, CLEAR, REPLACE, PATCH, PUSH
- value: string
Example
{
"action": "string",
"value": "string"
}
File: object
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)"
}
GenericResponse: object
- value: string SUCCESS, NO_UPDATE, NOT_FOUND, ERROR
Example
{
"value": "string"
}
GoalRepresentation: object
- bearLoss: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
- customTemplate: CustomTemplatePortfolioSelection
- endDate: DateRepresentation
- goalAmount: number (double)
- id: string
- investmentPurpose: string BUFFER, RETIREMENT, GENERAL, CHILD_SAVINGS, OTHER
- maximalRisk: number (float)
- monthlyInvestment: number (double)
- monthlyPayout: number (double)
- name: string
- parent: boolean
- parentId: string
- payoutEndDate: DateRepresentation
- sri: boolean
- startInvestment: number (double)
- strategy: 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
{
"bearLoss": "string",
"customTemplate": {
"type": "string"
},
"endDate": "string",
"goalAmount": "number (double)",
"id": "string",
"investmentPurpose": "string",
"maximalRisk": "number (float)",
"monthlyInvestment": "number (double)",
"monthlyPayout": "number (double)",
"name": "string",
"parent": "boolean",
"parentId": "string",
"payoutEndDate": "string",
"sri": "boolean",
"startInvestment": "number (double)",
"strategy": "string"
}
ISKReport: object
Example
{
"deductedForeignTax": "number (double)",
"deposits": "number (double)",
"incomeMultiplier": "number (double)",
"iskIncome": "number (double)",
"portfolioId": "string",
"q1Initial": "number (double)",
"q2Initial": "number (double)",
"q3Initial": "number (double)",
"q4Initial": "number (double)",
"reportType": "string",
"year": "integer (int32)"
}
IdentifiablePortfolioValue«PortfolioAccountNumber»: object
- portfolioId: string
- value: PortfolioAccountNumber
Example
{
"portfolioId": "string",
"value": {
"accountNumber": "string"
}
}
IdentifiablePortfolioValue«PortfolioDistributionRepresentation»: object
- portfolioId: string
- value: PortfolioDistributionRepresentation
Example
{
"portfolioId": "string",
"value": {
"assets": [
{
"amount": "number (double)",
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "number (double)",
"value": "number (double)"
}
]
}
}
IdentifiablePortfolioValue«PortfolioValue»: object
- portfolioId: string
- value: PortfolioValue
Example
{
"portfolioId": "string",
"value": {
"reservations": {
"feeAmount": "number (double)",
"settlementAmount": "number (double)",
"totalAmount": "number (double)",
"withdrawalAmount": "number (double)"
},
"reservedAmount": "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"
}
}
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"
}
}
InternalPageRepresentationCustomerLogEntryExternal: object
- content: CustomerLogItem
-
CustomerLogItem - first: boolean
- last: boolean
- number: integer (int32)
- numberOfElements: integer (int32)
- size: integer (int32)
- totalElements: integer (int64)
- totalPages: integer (int32)
Example
{
"content": [
{
"id": "string",
"timestamp": "integer (int64)",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
InternalPageRepresentationPortfolioLogEntryRepresentation: object
- content: PortfolioLogEntryRepresentation
-
PortfolioLogEntryRepresentation - first: boolean
- last: boolean
- number: integer (int32)
- numberOfElements: integer (int32)
- size: integer (int32)
- totalElements: integer (int64)
- totalPages: integer (int32)
Example
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
InternalPageRepresentation«CustomerLogItem»: object
- content: CustomerLogItem
-
CustomerLogItem - first: boolean
- last: boolean
- number: integer (int32)
- numberOfElements: integer (int32)
- size: integer (int32)
- totalElements: integer (int64)
- totalPages: integer (int32)
Example
{
"content": [
{
"id": "string",
"timestamp": "integer (int64)",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
InternalPageRepresentation«PortfolioLogEntryRepresentation»: object
- content: PortfolioLogEntryRepresentation
-
PortfolioLogEntryRepresentation - first: boolean
- last: boolean
- number: integer (int32)
- numberOfElements: integer (int32)
- size: integer (int32)
- totalElements: integer (int64)
- totalPages: integer (int32)
Example
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
],
"first": "boolean",
"last": "boolean",
"number": "integer (int32)",
"numberOfElements": "integer (int32)",
"size": "integer (int32)",
"totalElements": "integer (int64)",
"totalPages": "integer (int32)"
}
InternalPortfolioValueChangeRepresentation: object
- amount: Decimal
- assetId: string
- epochDay: integer (int64)
- type: string ADDITIVE, MULTIPLICATIVE
Example
{
"amount": "number (double)",
"assetId": "string",
"epochDay": "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)"
}
]
}
InvestmentStrategyDataRepresentation: object
- defaultFee: Decimal
- estimatedReturn: Decimal
- piOneMonth: Decimal
- piOneYear: Decimal
- sig2OneMonth: Decimal
- sigOneMonth: Decimal
- sigOneYear: Decimal
- 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
- templateId: string
- volatility: Decimal
Example
{
"defaultFee": "number (double)",
"estimatedReturn": "number (double)",
"piOneMonth": "number (double)",
"piOneYear": "number (double)",
"sig2OneMonth": "number (double)",
"sigOneMonth": "number (double)",
"sigOneYear": "number (double)",
"strategyIndex": "string",
"targetDistribution": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"templateId": "string",
"volatility": "number (double)"
}
InvestmentStrategyRepresentation: object
- dataRepresentations: InvestmentStrategyDataRepresentation
-
InvestmentStrategyDataRepresentation - defaultFee: Fee
- rule: InvestmentRuleRepresentation
Example
{
"dataRepresentations": [
{
"defaultFee": "number (double)",
"estimatedReturn": "number (double)",
"piOneMonth": "number (double)",
"piOneYear": "number (double)",
"sig2OneMonth": "number (double)",
"sigOneMonth": "number (double)",
"sigOneYear": "number (double)",
"strategyIndex": "string",
"targetDistribution": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"templateId": "string",
"volatility": "number (double)"
}
],
"defaultFee": {
"fixedTradeFee": {
"exchangeFee": "number (double)",
"tradeFee": "number (double)"
},
"managementFee": "number (double)",
"noValueBasedDiscount": "boolean",
"safekeepingFee": "number (double)",
"tradeFeesNotIncluded": "boolean",
"valueBasedDiscount": "number (double)",
"vat": "number (double)"
},
"rule": "object"
}
InvestmentStrategyRuleFormData: object
- sri: boolean
- strategyType: 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
{
"sri": "boolean",
"strategyType": "string"
}
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)"
}
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)"
}
KnowledgeTestCompletion: object
- questions: KnowledgeTestQuestion
-
KnowledgeTestQuestion - type: string test, funds, stocks, copy_portfolio, sri_preference
- version: integer (int32)
Example
{
"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"
}
Like: object
- likedByUser: boolean
- likedId: string
- likes: integer (int32)
- type: string CUSTOM_TEMPLATE_PORTFOLIO_LOG, NOTIFICATION_GENERATOR
Example
{
"likedByUser": "boolean",
"likedId": "string",
"likes": "integer (int32)",
"type": "string"
}
LikePayload: object
- likedId: string
- type: string CUSTOM_TEMPLATE_PORTFOLIO_LOG, NOTIFICATION_GENERATOR
Example
{
"likedId": "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"
}
}
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"
}
}
NotificationGeneratorAndStatus: object
- created: DateTimeRepresentation
- enabled: boolean
- filter: NotificationFilter
- id: string
- medium: string EMAIL, IN_APP
- name: string
- period: string MANUAL, HOURLY, DAILY, ON_LOGIN
- status: string NEW, READ, DELETED
- template: NotificationTemplate
Example
{
"created": "string",
"enabled": "boolean",
"filter": {
"filter": "object"
},
"id": "string",
"medium": "string",
"name": "string",
"period": "string",
"status": "string",
"template": {
"content": "object",
"contentType": "string",
"expiration": "string",
"id": "string",
"name": "string",
"type": "string"
}
}
NotificationPatch: object
- status: FieldPatch«string»
Example
{
"status": {
"action": "string",
"value": "string"
}
}
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"
}
OnboardingGoalSuggestionConfiguration: 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)
- retirementConfiguration: RetirementConfiguration
- selectedInvestments: string[]
-
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 - sri: boolean
- startInvestment: integer (int32)
- timeHorizon: integer (int32)
Example
{
"accountType": "string",
"age": "integer (int32)",
"bearLoss": "string",
"income": "integer (int32)",
"monthlyInvestment": "integer (int32)",
"retirementConfiguration": {
"payoutAmount": "integer (int32)",
"payoutEndAge": "integer (int32)",
"payoutStartAge": "integer (int32)"
},
"selectedInvestments": [
"string"
],
"sri": "boolean",
"startInvestment": "integer (int32)",
"timeHorizon": "integer (int32)"
}
OnboardingTypeSuggestionConfiguration: 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)"
}
OngoingTransaction: object
- amount: Decimal
- bankAccountId: string
- cancelable: boolean
- id: string
- initiated: DateTimeRepresentation
- lastUpdated: DateTimeRepresentation
- portfolioId: string
- protocol: string BANKGIRO, AUTOGIRO, SWISH, OTHER
- status: string PENDING_TRADE, PENDING_TRANSACTION, PENDING_ACCOUNT, ACCOUNT_ERROR, PREPARING_TRANSACTION, COMPLETED, CANCELED, ERROR
- type: string DEPOSIT, ORDER_BUY, ORDER_SELL, WITHDRAWAL, FULL_WITHDRAWAL
Example
{
"amount": "number (double)",
"bankAccountId": "string",
"cancelable": "boolean",
"id": "string",
"initiated": "string",
"lastUpdated": "string",
"portfolioId": "string",
"protocol": "string",
"status": "string",
"type": "string"
}
OptionContainer: object
- title: string
- value: string
Example
{
"title": "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
- email: string
- lei: string
- name: string
- organizationNumber: OrganizationNumber
- principal: Principal
- status: string pending, reviewing, active, pending_delete, deleted, stale
- uuid: string
Example
{
"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"
}
},
"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"
}
}
OrganizationKnowledgeTypesRepresentation: object
- cashSourceOptions: OptionContainer
-
OptionContainer - investmentSizeOptions: OptionContainer
-
OptionContainer
Example
{
"cashSourceOptions": [
{
"title": "string",
"value": "string"
}
],
"investmentSizeOptions": [
{
"title": "string",
"value": "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"
}
OrganizationWithUsers: object
- confirmEmail: string
- email: string
- lei: string
- name: string
- organizationNumber: OrganizationNumber
- principal: Principal
- status: string pending, reviewing, active, pending_delete, deleted, stale
- users: OrganizationUser
-
OrganizationUser - uuid: string
Example
{
"confirmEmail": "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"
}
},
"status": "string",
"users": [
{
"lastUpdated": "string",
"organizationId": "string",
"organizationRole": "string",
"userId": "string",
"userName": "string",
"uuid": "string"
}
],
"uuid": "string"
}
PaymentReferenceData: object
- bankGiro: integer (int64)
- portfolioId: string
- reference: string
Example
{
"bankGiro": "integer (int64)",
"portfolioId": "string",
"reference": "string"
}
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"
}
PortfolioCashTransferPayload: object
- amount: Decimal
- orderEstimate: OrderEstimateItem
-
OrderEstimateItem - sourceId: string
- targetId: string
Example
{
"amount": "number (double)",
"orderEstimate": [
{
"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)"
}
],
"sourceId": "string",
"targetId": "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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "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)"
}
PortfolioDataUserPatch: object
- endDate: FieldPatch«long»
- goalAmount: FieldPatch«Decimal»
- investmentStrategyType: FieldPatch«string»
- maximalRisk: FieldPatch«float»
- monthlyPayout: FieldPatch«Decimal»
- name: FieldPatch«string»
- payoutEndDate: FieldPatch«long»
- templatePortfolioActionStatus: FieldPatch«string»
- wallpaper: FieldPatch«Wallpaper»
Example
{
"endDate": {
"action": "string",
"value": "integer (int64)"
},
"goalAmount": {
"action": "string",
"value": "number (double)"
},
"investmentStrategyType": {
"action": "string",
"value": "string"
},
"maximalRisk": {
"action": "string",
"value": "number (float)"
},
"monthlyPayout": {
"action": "string",
"value": "number (double)"
},
"name": {
"action": "string",
"value": "string"
},
"payoutEndDate": {
"action": "string",
"value": "integer (int64)"
},
"templatePortfolioActionStatus": {
"action": "string",
"value": "string"
},
"wallpaper": {
"action": "string",
"value": {
"id": "string",
"protocol": "string"
}
}
}
PortfolioDistributionPartRepresentation: object
Example
{
"amount": "number (double)",
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "number (double)",
"value": "number (double)"
}
PortfolioDistributionRepresentation: object
Example
{
"assets": [
{
"amount": "number (double)",
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "number (double)",
"value": "number (double)"
}
]
}
PortfolioInternalWithdrawalPayload: object
- amount: Decimal
- fullWithdrawal: boolean
- orderEstimate: OrderEstimateItem
-
OrderEstimateItem - sourceId: string
- targetId: string
Example
{
"amount": "number (double)",
"fullWithdrawal": "boolean",
"orderEstimate": [
{
"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)"
}
],
"sourceId": "string",
"targetId": "string"
}
PortfolioLogEntryRepresentation: object
- id: string
- portfolioId: string
- timestamp: integer (int64)
- type: string DEPOSIT, INTERNAL_TRANSFER, WITHDRAWAL, FEE_DEDUCTED, TRADE, ASSET_UPDATE, DIVIDEND, REFERRAL_PAYOUT, GENERIC
- userId: string
Example
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "string"
}
PortfolioLogFilter: object
- maxDate: DateRepresentation
- portfolios: 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
{
"maxDate": "string",
"portfolios": [
"string"
],
"types": [
"string"
]
}
PortfolioPart: object
- amount: Decimal
- assetId: string
Example
{
"amount": "number (double)",
"assetId": "string"
}
PortfolioSignature: object
- adviceMaterial: CustomerAdviceMaterial
- created: integer (int64)
- guide: boolean
- portfolioData: PortfolioCreateData
- recommendationStatus: string NOT_RECOMMENDED, RECOMMENDATION_NOT_FOUND, HAS_RECOMMENDATION
- recommendedPortfolioData: PortfolioCreateData
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)"
},
"created": "integer (int64)",
"guide": "boolean",
"portfolioData": {
"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"
},
"recommendationStatus": "string",
"recommendedPortfolioData": {
"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"
}
}
PortfolioState: object
- depositBalance: Decimal
- depositTriggers: DepositTrigger
-
DepositTrigger - feeWithdrawalBalance: Decimal
- fullWithdrawal: 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
- tradeActionIdentifier: 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",
"pendingDeposit": "boolean",
"pendingFeeWithdrawal": "boolean",
"pendingRealloc": "boolean",
"pendingTrade": "boolean",
"pendingWithdrawal": "boolean",
"reallocTriggerType": "string",
"tradeActionIdentifier": "string",
"tradeSubState": "string",
"withdrawalBalance": "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"
}
PortfolioTradeOrderCreateData: object
- amount: Decimal
- assets: PortfolioTradeOrderItem
-
PortfolioTradeOrderItem - orderEstimates: OrderEstimateItem
-
OrderEstimateItem - 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
- type: string buy, sell, sell_all, dividend, payout
Example
{
"amount": "number (double)",
"assets": [
{
"amount": "number (double)",
"assetId": "string",
"tradeUnit": "string",
"value": "number (double)"
}
],
"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)"
}
],
"sourceId": "string",
"sourceType": "string",
"targetId": "string",
"targetType": "string",
"type": "string"
}
PortfolioTradeOrderCreateRecurringData: object
- amount: Decimal
- assets: PortfolioTradeOrderItem
-
PortfolioTradeOrderItem - orderEstimates: OrderEstimateItem
-
OrderEstimateItem - 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
- 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)"
}
],
"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)"
}
],
"sourceId": "string",
"sourceType": "string",
"targetId": "string",
"targetType": "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"
}
PortfolioTradeSummary: object
- portfolioId: string
- summary: TradeSummary
Example
{
"portfolioId": "string",
"summary": {
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
}
PortfolioTransferResult: object
- amount: Decimal
- feeValue: Decimal
- source: PortfolioData
- target: PortfolioData
- transferFraction: Decimal
Example
{
"amount": "number (double)",
"feeValue": "number (double)",
"source": {
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
},
"target": {
"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": {
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
},
"templatePortfolioActionStatus": "string",
"wallpaper": {
"id": "string",
"protocol": "string"
}
},
"transferFraction": "number (double)"
}
PortfolioValue: object
- reservations: CashReservations
- reservedAmount: Decimal
- returnValue: Decimal
-
Time weighted return value for the portfolio
- returnValueLatestMonth: Decimal
- returnValueLatestYear: Decimal
- totalEarnings: Decimal
- totalInvested: Decimal
- totalValue: Decimal
- totalWithdrawn: Decimal
- updated: DateTimeRepresentation
Example
{
"reservations": {
"feeAmount": "number (double)",
"settlementAmount": "number (double)",
"totalAmount": "number (double)",
"withdrawalAmount": "number (double)"
},
"reservedAmount": "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"
}
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"
}
}
Recommendation: object
- priority: integer (int32)
- source: string
- sourceId: string
- sourceType: string asset, portfolio
- targetId: string
- targetType: string asset, portfolio
Example
{
"priority": "integer (int32)",
"source": "string",
"sourceId": "string",
"sourceType": "string",
"targetId": "string",
"targetType": "string"
}
RecurringTransaction: object
- amount: Decimal
- bankAccountId: string
- created: DateTimeRepresentation
- paused: boolean
- portfolioIndex: integer (int32)
- protocol: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
- transactionDay: integer (int32)
- type: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
- uuid: string
Example
{
"amount": "number (double)",
"bankAccountId": "string",
"created": "string",
"paused": "boolean",
"portfolioIndex": "integer (int32)",
"protocol": "string",
"transactionDay": "integer (int32)",
"type": "string",
"uuid": "string"
}
RecurringTransactionCreateData: object
- amount: Decimal
- bankAccountId: string
- portfolioIndex: integer (int32)
- transactionDay: integer (int32)
- type: string DEPOSIT, EXTERNAL_TRANSFER, DIVIDEND, FEE, BULK_FEE, FEE_INVOICE, TRADE_FEE, CURRENCY_EXCHANGE_FEE, BULK_TRADE_FEE, WITHDRAWAL
Example
{
"amount": "number (double)",
"bankAccountId": "string",
"portfolioIndex": "integer (int32)",
"transactionDay": "integer (int32)",
"type": "string"
}
RecurringTransactionPatch: object
- amount: FieldPatch«Decimal»
- bankAccount: FieldPatch«string»
- paused: FieldPatch«boolean»
Example
{
"amount": {
"action": "string",
"value": "number (double)"
},
"bankAccount": {
"action": "string",
"value": "string"
},
"paused": {
"action": "string",
"value": "boolean"
}
}
RecurringUpdate: object
- orderState: FieldPatch«string»
- transactionDay: FieldPatch«int»
Example
{
"orderState": {
"action": "string",
"value": "string"
},
"transactionDay": {
"action": "string",
"value": "integer (int32)"
}
}
ReferralPayoutConfiguration: object
- depositShare: Decimal
Example
{
"depositShare": "number (double)"
}
RetirementConfiguration: object
- payoutAmount: integer (int32)
- payoutEndAge: integer (int32)
- payoutStartAge: integer (int32)
Example
{
"payoutAmount": "integer (int32)",
"payoutEndAge": "integer (int32)",
"payoutStartAge": "integer (int32)"
}
SharableCustomTemplate: object
- accessibility: string private, public, delisted
- created: DateTimeRepresentation
- distribution: TemplatePortfolioDistributionPart
-
TemplatePortfolioDistributionPart - id: string
- meta: CustomTemplatePortfolioMeta
- published: DateTimeRepresentation
- sharerProfile: UserProfile
- ter: Decimal
- value: CustomTemplatePortfolioValue
Example
{
"accessibility": "string",
"created": "string",
"distribution": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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",
"sri": "boolean",
"status": {
"level": "string",
"trigger": "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)",
"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)"
}
}
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)"
}
SignableOnboardingDocument: object
- document: BwDocument
- goalId: string
- signableGroupId: SignableGroupId
Example
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"goalId": "string",
"signableGroupId": {
"groupId": "string",
"groupType": "string",
"major": "integer (int32)",
"minor": "integer (int32)"
}
}
SwishTransactionCreatePayload: object
- amount: Decimal
- orderEstimate: OrderEstimateItem
-
OrderEstimateItem - portfolioId: string
Example
{
"amount": "number (double)",
"orderEstimate": [
{
"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)"
}
],
"portfolioId": "string"
}
TaxReport: object
- portfolioId: string
- reportType: string ISK, SALES
- year: integer (int32)
Example
{
"portfolioId": "string",
"reportType": "string",
"year": "integer (int32)"
}
TemplatePortfolio: object
- assets: TemplatePortfolioDistributionPart
-
TemplatePortfolioDistributionPart - estimatedReturn: number (double)
- id: string
- lastDistributionChange: integer (int64)
- maxDD: number (double)
- name: string
- sri: boolean
- 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
- target: TargetDistribution
- targetVar: number (double)
- var: number (double)
- volatility: number (double)
Example
{
"assets": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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)",
"maxDD": "number (double)",
"name": "string",
"sri": "boolean",
"strategyIndex": "string",
"target": {
"alternative": "number (double)",
"bonds": "number (double)",
"commodities": "number (double)",
"stocks": "number (double)"
},
"targetVar": "number (double)",
"var": "number (double)",
"volatility": "number (double)"
}
TemplatePortfolioDistributionPart: object
Example
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "number (double)",
"sixMonths": "number (double)",
"thisYear": "number (double)",
"threeMonths": "number (double)",
"threeYears": "number (double)"
}
},
"fraction": "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"
}
TokenizedPageActionCodeActivationConversionMetric: object
- content: CodeConversionMetric
-
CodeConversionMetric - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"activated": "string",
"codeId": "string",
"converted": "string",
"fullyConverted": "boolean",
"id": "string"
}
],
"first": "boolean",
"last": "boolean",
"nextToken": "string",
"size": "integer (int32)",
"token": "string",
"totalSize": "integer (int32)"
}
TokenizedPageCompletedTradeItem: object
- content: CompletedTradeItem
-
CompletedTradeItem - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"amount": "number (double)",
"assetId": "string",
"currency": "string",
"currencyExchangeRate": "number (double)",
"currencyFee": "number (double)",
"marketplace": [
"string"
],
"portfolioId": "string",
"price": "number (double)",
"savedCurrencyFee": "number (double)",
"savedTradeFee": "number (double)",
"settlementTimestamp": "integer (int64)",
"timestamp": "integer (int64)",
"tradeFee": "number (double)",
"tradeOrderId": "string",
"tradedTimestamp": "integer (int64)",
"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)"
}
TokenizedPageExternalAsset: object
Example
{
"content": [
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "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)"
}
TokenizedPagePortfolioLogEntryRepresentation: object
- content: PortfolioLogEntryRepresentation
-
PortfolioLogEntryRepresentation - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "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)"
}
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«Asset»: object
Example
{
"content": [
{
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "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«CodeConversionMetric»: object
- content: CodeConversionMetric
-
CodeConversionMetric - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"activated": "string",
"codeId": "string",
"converted": "string",
"fullyConverted": "boolean",
"id": "string"
}
],
"first": "boolean",
"last": "boolean",
"nextToken": "string",
"size": "integer (int32)",
"token": "string",
"totalSize": "integer (int32)"
}
TokenizedPage«CompletedTradeItem»: object
- content: CompletedTradeItem
-
CompletedTradeItem - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"amount": "number (double)",
"assetId": "string",
"currency": "string",
"currencyExchangeRate": "number (double)",
"currencyFee": "number (double)",
"marketplace": [
"string"
],
"portfolioId": "string",
"price": "number (double)",
"savedCurrencyFee": "number (double)",
"savedTradeFee": "number (double)",
"settlementTimestamp": "integer (int64)",
"timestamp": "integer (int64)",
"tradeFee": "number (double)",
"tradeOrderId": "string",
"tradedTimestamp": "integer (int64)",
"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«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«PortfolioLogEntryRepresentation»: object
- content: PortfolioLogEntryRepresentation
-
PortfolioLogEntryRepresentation - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"id": "string",
"portfolioId": "string",
"timestamp": "integer (int64)",
"type": "string",
"userId": "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«SharableCustomTemplate»: object
- content: SharableCustomTemplate
-
SharableCustomTemplate - first: boolean
- last: boolean
- nextToken: string
- size: integer (int32)
- token: string
- totalSize: integer (int32)
Example
{
"content": [
{
"accessibility": "string",
"created": "string",
"distribution": [
{
"asset": {
"added": "string",
"assetClass": "string",
"aum": "number (double)",
"aumCurrency": "string",
"aumDate": "string",
"baseValue": {
"lastClosing": "number (double)",
"lastClosingDate": "string"
},
"benchmarkName": "string",
"category": "string",
"ceo": "string",
"comments": "string",
"country": "string",
"currency": "string",
"currencyAllocation": "object",
"currencyAllocationDate": "string",
"currencyExchangeFeeDisabled": "boolean",
"description": "string",
"dividend": "boolean",
"dividendCurrency": "string",
"dividendFrequency": "string",
"dividendYield": "number (double)",
"exchangeCode": "string",
"geoAllocation": "object",
"geoAllocationDate": "string",
"geography": "string",
"holdingsAllocation": "object",
"holdingsAllocationDate": "string",
"id": "string",
"inceptionDate": "string",
"isActivePlatform": "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",
"numEmployees": "integer (int32)",
"numberOfHoldings": "integer (int32)",
"numberOfHoldingsDate": "string",
"replicationStrategy": "string",
"riskFactor": "string",
"riskLevel": "integer (int32)",
"sectors": [
"string"
],
"sharesTotal": "integer (int32)",
"shortName": "string",
"sri": "boolean",
"strategyDescription": "string",
"ter": "number (double)",
"ticker": "string",
"tradeFeeDisabled": "boolean",
"tradeStopped": "boolean",
"type": "string",
"ucits": "boolean",
"url": "string",
"value": {
"currency": "string",
"fiveYears": "number (double)",
"last": "number (double)",
"lastClosing": "number (double)",
"lastClosingDate": "string",
"lastPeriodUpdate": "string",
"lastValueUpdated": "string",
"oneMonth": "number (double)",
"oneYear": "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",
"sri": "boolean",
"status": {
"level": "string",
"trigger": "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)",
"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)"
}
TradeSummaries: object
- assetId: string
- buy: TradeData
- portfolios: PortfolioTradeSummary
-
PortfolioTradeSummary - sell: TradeData
Example
{
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"portfolios": [
{
"portfolioId": "string",
"summary": {
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
}
],
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
TradeSummary: object
Example
{
"assetId": "string",
"buy": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
},
"sell": {
"avgPrice": "number (double)",
"totalAmount": "number (double)",
"totalCurrencyFee": "number (double)",
"totalTradeFee": "number (double)"
}
}
Transaction: object
- amount: Decimal
-
Amount of transaction
- created: integer (int64)
-
Created timestamp of transaction
- errorMessage: string
-
Error specification, may be set if transaction status is ERROR
- externalId: string
-
External id of transaction
- internalId: string
-
Internal id of transaction
- portfolioUuid: string
-
Id of related portfolio
- protocol: string MANUAL, BG_MAX, AUTOGIRO, SWISH, INTERNAL, MONOPOLY
-
Protocol used to create/complete the transaction, like for example BGMax (BankGiro)
- recurringTransactionDate: DateTimeRepresentation
-
Date of transaction, if the origin is a recurring transaction
- status: string PENDING, EXPORTED, SPLIT, ERROR, FAILED, CANCELED, COMPLETED, BULKED
-
Status of transaction
- targetAccount: BankAccount
-
Target account of transaction (if applicable, shall otherwise be set to null)
- type: string DEPOSIT, FEE, BULK_FEE, FEE_INVOICE, WITHDRAWAL
-
Type of transaction, DEPOSIT, WITHDRAWAL, FEE etc.
- updated: integer (int64)
-
Time for last update of transaction
- userUuid: string
- uuid: string
-
Id of transaction
Example
{
"amount": "number (double)",
"created": "integer (int64)",
"errorMessage": "string",
"externalId": "string",
"internalId": "string",
"portfolioUuid": "string",
"protocol": "string",
"recurringTransactionDate": "string",
"status": "string",
"targetAccount": {
"accountNumber": "string",
"autogiroStatus": "string",
"bankIdentifier": "string",
"clearingNumber": "string",
"name": "string",
"primary": "boolean",
"signature": "string",
"userUuid": "string",
"uuid": "string"
},
"type": "string",
"updated": "integer (int64)",
"userUuid": "string",
"uuid": "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
- email: string
- firstName: string
- id: string
- lastName: string
- newsletter: boolean
- notifications: boolean
- personalNumber: PersonalNumber
- phone: string
- premiumContact: External
- premiumLevel: string none, level_one
- userProfileAlias: string
Example
{
"clientId": "string",
"clientIdMigrationTarget": "string",
"clientIdOriginal": "string",
"confirmEmail": "string",
"created": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "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"
}
UserFavorite: object
- created: DateTimeRepresentation
- id: string
- type: string ASSET, AUTO_COPY_PORTFOLIO
Example
{
"created": "string",
"id": "string",
"type": "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"
}
UserKnowledgePatch: object
- cashSources: FieldPatch«Map«string,boolean»»
- citizenship: FieldPatch«Set«string»»
- completedKnowledgeTests: FieldPatch«List«KnowledgeTestCompletion»»
- depositPeriodicity: FieldPatch«string»
- employment: FieldPatch«string»
- funds: FieldPatch«boolean»
- income: FieldPatch«double»
- investmentPurpose: FieldPatch«Map«string,boolean»»
- investmentSize: FieldPatch«string»
- liquidAssets: FieldPatch«string»
- loansAndCredits: FieldPatch«boolean»
- lossKnowledge: FieldPatch«boolean»
- pep: FieldPatch«string»
- pepPosition: FieldPatch«string»
- pepRelation: FieldPatch«string»
- pepRelationPosition: FieldPatch«string»
- transferSource: FieldPatch«string»
- unrealizedLiquidAssets: FieldPatch«string»
- withdrawalPeriodicity: FieldPatch«string»
Example
{
"cashSources": {
"action": "string",
"value": "object"
},
"citizenship": {
"action": "string",
"value": [
"string"
]
},
"completedKnowledgeTests": {
"action": "string",
"value": [
{
"questions": [
{
"answerId": "string",
"questionId": "string"
}
],
"type": "string",
"version": "integer (int32)"
}
]
},
"depositPeriodicity": {
"action": "string",
"value": "string"
},
"employment": {
"action": "string",
"value": "string"
},
"funds": {
"action": "string",
"value": "boolean"
},
"income": {
"action": "string",
"value": "number (double)"
},
"investmentPurpose": {
"action": "string",
"value": "object"
},
"investmentSize": {
"action": "string",
"value": "string"
},
"liquidAssets": {
"action": "string",
"value": "string"
},
"loansAndCredits": {
"action": "string",
"value": "boolean"
},
"lossKnowledge": {
"action": "string",
"value": "boolean"
},
"pep": {
"action": "string",
"value": "string"
},
"pepPosition": {
"action": "string",
"value": "string"
},
"pepRelation": {
"action": "string",
"value": "string"
},
"pepRelationPosition": {
"action": "string",
"value": "string"
},
"transferSource": {
"action": "string",
"value": "string"
},
"unrealizedLiquidAssets": {
"action": "string",
"value": "string"
},
"withdrawalPeriodicity": {
"action": "string",
"value": "string"
}
}
UserKnowledgeTypesRepresentation: object
- cashSourceOptions: OptionContainer
-
OptionContainer - depositPeriodicityOptions: OptionContainer
-
OptionContainer - employmentOptions: OptionContainer
-
OptionContainer - investmentPurposeOptions: OptionContainer
-
OptionContainer - investmentSizeOptions: OptionContainer
-
OptionContainer - pepPositionOptions: OptionContainer
-
OptionContainer - pepRelationOptions: OptionContainer
-
OptionContainer - transferSourceOptions: OptionContainer
-
OptionContainer - withdrawalPeriodicityOptions: OptionContainer
-
OptionContainer
Example
{
"cashSourceOptions": [
{
"title": "string",
"value": "string"
}
],
"depositPeriodicityOptions": [
{
"title": "string",
"value": "string"
}
],
"employmentOptions": [
{
"title": "string",
"value": "string"
}
],
"investmentPurposeOptions": [
{
"title": "string",
"value": "string"
}
],
"investmentSizeOptions": [
{
"title": "string",
"value": "string"
}
],
"pepPositionOptions": [
{
"title": "string",
"value": "string"
}
],
"pepRelationOptions": [
{
"title": "string",
"value": "string"
}
],
"transferSourceOptions": [
{
"title": "string",
"value": "string"
}
],
"withdrawalPeriodicityOptions": [
{
"title": "string",
"value": "string"
}
]
}
UserPatch: object
- newsletter: FieldPatch«boolean»
- notifications: FieldPatch«boolean»
- phone: FieldPatch«string»
Example
{
"newsletter": {
"action": "string",
"value": "boolean"
},
"notifications": {
"action": "string",
"value": "boolean"
},
"phone": {
"action": "string",
"value": "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"
}
UserProfilePatch: object
- alias: FieldPatch«string»
- description: FieldPatch«string»
- facebookLink: FieldPatch«string»
- instagramLink: FieldPatch«string»
- linkedinLink: FieldPatch«string»
- tikTokLink: FieldPatch«string»
Example
{
"alias": {
"action": "string",
"value": "string"
},
"description": {
"action": "string",
"value": "string"
},
"facebookLink": {
"action": "string",
"value": "string"
},
"instagramLink": {
"action": "string",
"value": "string"
},
"linkedinLink": {
"action": "string",
"value": "string"
},
"tikTokLink": {
"action": "string",
"value": "string"
}
}
UserWithRoles: object
- admin: ExternalAdmin
- 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
- email: string
- favorites: UserFavorite
-
UserFavorite - features: string[]
-
string - firstName: string
- id: string
- lastName: string
- newsletter: boolean
- notifications: boolean
- organization: OrganizationWithUsers
- personalNumber: PersonalNumber
- phone: string
- premiumContact: External
- premiumLevel: string none, level_one
- userProfileAlias: string
Example
{
"admin": {
"name": "string",
"uuid": "string"
},
"clientId": "string",
"clientIdMigrationTarget": "string",
"clientIdOriginal": "string",
"confirmEmail": "string",
"created": "string",
"email": "string",
"favorites": [
{
"created": "string",
"id": "string",
"type": "string"
}
],
"features": [
"string"
],
"firstName": "string",
"id": "string",
"lastName": "string",
"newsletter": "boolean",
"notifications": "boolean",
"organization": {
"confirmEmail": "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"
}
},
"status": "string",
"users": [
{
"lastUpdated": "string",
"organizationId": "string",
"organizationRole": "string",
"userId": "string",
"userName": "string",
"uuid": "string"
}
],
"uuid": "string"
},
"personalNumber": {
"age": "integer (int32)",
"canonical": "string",
"canonicalAsLong": "integer (int64)",
"prefix": "string"
},
"phone": "string",
"premiumContact": {
"documents": [
{
"document": {
"category": "string",
"contentType": "string",
"documentId": "string",
"documentUrl": "string",
"hash": "string",
"title": "string",
"type": "string"
},
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"signatureId": "string",
"signedDate": "string"
}
],
"email": "string",
"entityId": "string",
"groupIdentifier": {
"documentGroupId": "string",
"documentGroupType": "string",
"documentGroupVersion": {
"major": "integer (int32)",
"minor": "integer (int32)"
},
"parentId": "string"
},
"id": "string",
"imageUrl": "string",
"name": "string",
"phone": "string",
"prevVersion": "#/definitions/External",
"resignRequired": "boolean",
"signedDate": "string"
},
"premiumLevel": "string",
"userProfileAlias": "string"
}
ValueHistory: 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)"
}
]
}