Download OpenAPI specification:Download
Retrieve a specific account (active or inactive).
contactId required | integer <int32> The ID of the contact that is part of the Account's Contact Group |
accountId required | integer <int32> The ID of the account to be retrieved. |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 7,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "00250007871200007549",
- "Iban": "00250007871200007549",
- "InternalId": "871200007549",
- "Name": "00250007871200007549",
- "Balance": 1854.09,
- "BalanceLastUpdateDate": "2019-12-01T00:00:00",
- "BranchId": 4,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": -0.005
}, - "ContactGroupId": 5,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "OpeningDate": "2023-12-18T14:35:36.5052722+00:00",
- "ProductId": 3,
- "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2025-06-18T14:35:36.5052739+00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "In Opening",
- "ExternalId": "In Opening"
}, - "Attributes": "{\"Description\": \"This the Account the Client always wanted to have!\"}",
- "SubAccounts": [ ],
- "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}
Retrieve all accounts of a contact (active or inactive).
contactId required | integer <int32> The contactId of the contact |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "Balance": 0,
- "BalanceLastUpdateDate": "2024-12-18T16:13:42Z",
- "BranchId": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "ContactGroupId": 0,
- "Type": {
- "Id": 0,
- "Name": "string",
- "InternalId": "string"
}, - "IsActive": true,
- "ParentId": 0,
- "OpeningDate": "2024-12-18T16:13:42Z",
- "ProductId": 0,
- "Status": {
- "Id": 0,
- "Name": "string"
}, - "ClosingDate": "2024-12-18T16:13:42Z",
- "IntegrationStatus": {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string"
}, - "Attributes": "string",
- "SubAccounts": [
- 0
], - "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2024-12-18T16:13:42Z"
}
]
Gets the account balance history (in the account currency).
contactId required | integer <int32> The ID of the contact that belongs to the Account's contact group |
accountId required | integer <int32> The ID of the account |
fromDate | string <date-time> The optional start date of the Account's balance history |
toDate | string <date-time> The optional end date of the Account's balance history |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Values": [
- {
- "Date": "2024-12-18T16:13:42Z",
- "Amount": 0
}
], - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
}
Modifies an existing account.
contactId required | integer <int32> The ID of the contact that belongs to the Account's contact group |
accountId required | integer <int32> The ID of the account to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
AccountNumber | string Nullable The optional new account number of the account. |
Iban | string Nullable The optional new IBAN of the account. |
InternalId | string Nullable The optional new Internal Id of the account. |
Name | string Nullable The optional new name of the account. |
BranchId | integer <int32> Nullable The optional new branch id of the account. |
AccountType | integer <int32> Nullable The optional new account type id of the account. |
Balance | number <double> Nullable The optional new balance of the account. |
BalanceDate | string <date-time> Nullable The optional new date of the last balance update of the account. |
IsActive | boolean Nullable This determines whether the Account is active or not. |
ParentId | integer <int32> Nullable The optional new parent id of the account. |
Product | integer <int32> Nullable The optional new product id of the account. |
Status | integer <int32> Nullable The optional new status of the account. |
OpeningDate | string <date-time> Nullable The optional new date when the account was opened. |
ClosingDate | string <date-time> Nullable The optional new date when the account was closed. |
IntegrationStatus | integer <int32> Nullable The optional new integration status id of the account. |
CustomAttributes | string Nullable The optional new custom attributes of the account. |
ContactGroupId | integer <int32> The contact group associated with the Account |
AvailableBalance | number <double> Nullable The optional available balance of the Account |
AvailableBalanceLastUpdateDate | string <date-time> Nullable The optional last available balance update date of the Account |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "BranchId": 0,
- "AccountType": 0,
- "Balance": 0,
- "BalanceDate": "2024-12-18T16:13:42Z",
- "IsActive": true,
- "ParentId": 0,
- "Product": 0,
- "Status": 0,
- "OpeningDate": "2024-12-18T16:13:42Z",
- "ClosingDate": "2024-12-18T16:13:42Z",
- "IntegrationStatus": 0,
- "CustomAttributes": "string",
- "ContactGroupId": 0,
- "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2024-12-18T16:13:42Z",
- "UpdateProperties": [
- "string"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Creates a new account.
contactId required | integer <int32> The ID of the contact for the new account |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
AccountNumber required | string non-empty The account number for the new account. |
Iban | string Nullable The IBAN for the new account. |
InternalId | string Nullable The Internal Id for the new account. |
Name | string Nullable The name of the new account. |
BranchId required | integer <int32> The id of the branch for the new account. |
CurrencyId required | integer <int32> The id of the currency for the new account. |
ContactGroupId | integer <int32> Nullable The id of the contact group for the new account. |
AccountType required | integer <int32> The id of the account type for the new account. |
Balance | number <double> Nullable The balance for the new account. |
BalanceDate | string <date-time> Nullable The date of the last update of the balance for the new account. |
IsActive | boolean This determines whether the Account is active or not. |
ParentId | integer <int32> Nullable The id of the parent for the new account. |
Product required | integer <int32> The id of the product for the new account. |
Status required | integer <int32> The id of the status for the new account. |
OpeningDate | string <date-time> Nullable The date when the account was opened. |
ClosingDate | string <date-time> Nullable The date when the account was closed. |
IntegrationStatus | integer <int32> Nullable The id of the integration status for the new account. |
CustomAttributes | string Nullable The custom attributes for the new account. |
AvailableBalance | number <double> Nullable This is the available balance of the Account |
AvailableBalanceLastUpdateDate | string <date-time> Nullable This is the last available balance update date of the Account |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AccountNumber": "002500078712000099999",
- "Iban": "002500078712000099999",
- "InternalId": "871200009999",
- "Name": "002500078712000099999",
- "BranchId": 4,
- "CurrencyId": 2,
- "ContactGroupId": 5,
- "AccountType": 1,
- "Balance": 1854.09,
- "BalanceDate": "2019-12-01T00:00:00",
- "IsActive": true,
- "Product": 3,
- "Status": 1,
- "OpeningDate": "2018-11-28T00:00:00",
- "ClosingDate": "2018-11-29T00:00:00",
- "CustomAttributes": "{\"Description\": \"Is this the Account the Client always wanted to have?\"}",
- "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2024-12-18T14:35:36.5159598+00:00"
}
{- "ContactId": 1,
- "Account": {
- "Id": 7,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "00250007871200007549",
- "Iban": "00250007871200007549",
- "InternalId": "871200007549",
- "Name": "00250007871200007549",
- "Balance": 1854.09,
- "BalanceLastUpdateDate": "2019-12-01T00:00:00",
- "BranchId": 4,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": -0.005
}, - "ContactGroupId": 5,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "OpeningDate": "2023-12-18T14:35:36.5160313+00:00",
- "Product": {
- "Fees": [ ],
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "ProductOfferId": 1,
- "Name": "<root><de>Discretionary</de><en>Discretionary</en><fr>Discretionary</fr><ja>Discretionary</ja><ru>Discretionary</ru></root>",
- "Description": "<root><de>Discretionary</de><en>Discretionary</en><fr /><ja /><ru /></root>",
- "Image": "",
- "Factsheet": "<root><en /></root>",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true
}, - "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2025-06-18T14:35:36.5160322+00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "In Opening",
- "ExternalId": "In Opening"
}, - "Attributes": "{\"Description\": \"This the Account the Client always wanted to have!\"}",
- "SubAccounts": [ ]
}
}
Allows the User to search for Accounts of an authenticated Contact for a given set of criteria
contactId required | integer <int32> The contactId of the contact |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search request parameters
BranchIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable Array with Currency Ids |
ContactGroupIds | Array of integers <int32> Nullable Array with Contact Group Ids |
AccountTypes | Array of strings (Domain.Abstractions.Enums.AccountType) Nullable Items Enum: "Cash" "Custody" "Savings" "Settlement" "Deposit" Array with Account Type Ids |
IsActive | boolean Nullable If null, active or inactive accounts are returned |
ProductIds | Array of integers <int32> Nullable Array with Product Ids |
AccountStatuses | Array of strings (AccountStatusId) Nullable Items Enum: "Active" "Blocked" "Inactive" "Closed" Array with Account Status Ids |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "BranchIds": [
- 1
], - "CurrencyIds": [
- 1
], - "ContactGroupIds": [
- 1
], - "AccountTypes": [
- "Cash"
], - "IsActive": true,
- "ProductIds": [
- 1
], - "AccountStatuses": [
- "Active"
], - "Page": 1,
- "PageSize": 10
}
{- "Results": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "12345800",
- "Iban": "CH9300762011623852957",
- "InternalId": "123456",
- "Name": "My New Account",
- "Balance": 1200,
- "BranchId": 12,
- "Currency": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Swiss Franc",
- "CurrencyCode": "CHF",
- "Symbol": "Fr",
- "RiskFreeRate": 0.0005
}, - "ContactGroupId": 6,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "ParentId": 2,
- "OpeningDate": "2019-11-01T00:00:00",
- "ProductId": 1,
- "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2020-01-01T00:00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "Integration Test",
- "ExternalId": "IntegrationTest"
}, - "Attributes": "{Test: 123}",
- "SubAccounts": [
- 1,
- 2,
- 3
], - "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}, - {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "AccountNumber": "5000000",
- "Iban": "CH9300000000000000000",
- "InternalId": "100000",
- "Name": "My Other Account",
- "Balance": 1200,
- "BranchId": 12,
- "Currency": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "EURO",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": 0.0005
}, - "ContactGroupId": 6,
- "Type": {
- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash"
}, - "IsActive": true,
- "ParentId": 2,
- "OpeningDate": "2019-11-01T00:00:00",
- "ProductId": 1,
- "Status": {
- "Id": 1,
- "Name": "Active"
}, - "ClosingDate": "2020-01-01T00:00:00",
- "IntegrationStatus": {
- "Id": 1,
- "Name": "Integration Test",
- "ExternalId": "IntegrationTest"
}, - "Attributes": "{Test: 123}",
- "SubAccounts": [
- 1,
- 2,
- 3
], - "AvailableBalance": 3000,
- "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}
], - "Page": 1,
- "PageSize": 10,
- "PageCount": 1,
- "TotalCount": 2
}
Searches for accounts and returns a list with accounts (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (PortfolioChangeId, LimitPrice, ExternalId) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
AccountNumber | string Nullable |
Iban | string Nullable |
InternalId | string Nullable |
Name | string Nullable |
Ids | Array of integers <int32> Nullable |
BranchIds | Array of integers <int32> Nullable |
BankIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
ContactGroupIds | Array of integers <int32> Nullable |
AccountTypeIds | Array of integers <int32> Nullable |
IsActive | boolean Nullable |
ParentIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
AccountStatusIds | Array of integers <int32> Nullable |
BalanceUpdateDateFrom | string <date-time> Nullable |
BalanceUpdateDateTo | string <date-time> Nullable |
OpeningDateFrom | string <date-time> Nullable |
OpeningDateTo | string <date-time> Nullable |
ClosingDateFrom | string <date-time> Nullable |
ClosingDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "Ids": [
- 0
], - "BranchIds": [
- 0
], - "BankIds": [
- 0
], - "CurrencyIds": [
- 0
], - "ContactIds": [
- 0
], - "ContactGroupIds": [
- 0
], - "AccountTypeIds": [
- 0
], - "IsActive": true,
- "ParentIds": [
- 0
], - "ProductIds": [
- 0
], - "AccountStatusIds": [
- 0
], - "BalanceUpdateDateFrom": "2024-12-18T16:13:42Z",
- "BalanceUpdateDateTo": "2024-12-18T16:13:42Z",
- "OpeningDateFrom": "2024-12-18T16:13:42Z",
- "OpeningDateTo": "2024-12-18T16:13:42Z",
- "ClosingDateFrom": "2024-12-18T16:13:42Z",
- "ClosingDateTo": "2024-12-18T16:13:42Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "BranchId": 0,
- "CurrencyId": 0,
- "ContactGroupId": 0,
- "AccountTypeId": 0,
- "IsActive": true,
- "ParentId": 0,
- "ProductId": 0,
- "AccountStatusId": 0,
- "Balance": 0,
- "BalanceUpdateDate": "2024-12-18T16:13:42Z",
- "OpeningDate": "2024-12-18T16:13:42Z",
- "ClosingDate": "2024-12-18T16:13:42Z",
- "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2024-12-18T16:13:42Z"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Delete bank
id required | integer <int32> Id of the existing bank |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Return a bank by id
id required | integer <int32> Bank id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "Name": "Europe bank",
- "Bic": "BARCGB22XXX",
- "Code": "x9x9x9x"
}
Update existing bank
id required | integer <int32> Id of the existing bank |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank to update
Name | string Nullable |
Bic | string Nullable |
Code | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Bic": "string",
- "Code": "string"
}
{- "Id": 1,
- "Name": "Europe bank",
- "Bic": "BARCGB22XXX",
- "Code": "x9x9x9x"
}
Deletes bank account type
id required | integer <int32> Id of the existing bank account type |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Returns a bank account type by id
id required | integer <int32> Bank account type id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
Updates existing bank account type
id required | integer <int32> Id of the existing bank account type |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank account type to update
Name | string Nullable |
InternalId | string Nullable |
Description | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
{- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
Delete bank branch from the system.
id required | integer <int32> Id of the existing bank branch |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Returns the list of all banks in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Bic": "string",
- "Code": "string"
}
]
Create a new bank
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank to create
Name | string Nullable |
Bic | string Nullable |
Code | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Bic": "string",
- "Code": "string"
}
{- "Id": 1,
- "Name": "Europe bank",
- "Bic": "BARCGB22XXX",
- "Code": "x9x9x9x"
}
Returns the list of all bank account types in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "InternalId": "string",
- "Description": "string"
}
]
Creates a new bank account type
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank account type to create
Name | string Nullable |
InternalId | string Nullable |
Description | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
{- "Id": 1,
- "Name": "Cash",
- "InternalId": "Cash",
- "Description": "Cash account type"
}
Returns bank branch by its id
id required | integer <int32> Id of the bank branch |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "Name": "0001 AD",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+3233356989"
}
Update existing bank branch.
id required | integer <int32> Id of the existing bank branch |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank branch to update
Name | string Nullable |
BankId | integer <int32> |
CountryId | integer <int32> Nullable |
Code | string Nullable |
AddressLine1 | string Nullable |
AddressLine2 | string Nullable |
AddressLine3 | string Nullable |
AddressLine4 | string Nullable |
Bic | string Nullable |
PhoneNumber | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Branch 1",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+32|33356989"
}
{- "Id": 1,
- "Name": "0001 AD",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+3233356989"
}
Returns the list of all bank branches in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "BankId": 0,
- "BankName": "string",
- "CountryId": 0,
- "CountryName": "string",
- "Code": "string",
- "AddressLine1": "string",
- "AddressLine2": "string",
- "AddressLine3": "string",
- "AddressLine4": "string",
- "Bic": "string",
- "PhoneNumber": "string"
}
]
Create a new bank branch in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the bank branch to create
Name | string Nullable |
BankId | integer <int32> |
CountryId | integer <int32> Nullable |
Code | string Nullable |
AddressLine1 | string Nullable |
AddressLine2 | string Nullable |
AddressLine3 | string Nullable |
AddressLine4 | string Nullable |
Bic | string Nullable |
PhoneNumber | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Branch 1",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+32|33356989"
}
{- "Id": 1,
- "Name": "0001 AD",
- "BankId": 1,
- "CountryId": 2,
- "Code": "227",
- "AddressLine1": "Rue des Avenges",
- "AddressLine2": "25",
- "AddressLine3": "6356",
- "AddressLine4": "Andorra",
- "Bic": "AD63746",
- "PhoneNumber": "+3233356989"
}
Deletes a risk category.
id required | integer <int32> The Id of the risk category |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Delete economical zone
id required | integer <int32> Id of the existing economical zone |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Deletes a rating agency.
ratingAgencyId required | integer <int32> Rating agency Id to be deleted |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Returns a rating agency by its id.
ratingAgencyId required | integer <int32> Rating agency Id |
language | string Language to translate the resource. If null, returns xml for all languages |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string"
}
Deletes a rating.
ratingAgencyId required | integer <int32> Rating agency Id |
ratingId required | integer <int32> Rating Id to be deleted |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Returns a rating by its id.
ratingAgencyId required | integer <int32> Rating agency Id |
ratingId required | integer <int32> Rating Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Rating": {
- "Id": 1,
- "Value": "Aaa",
- "Color": "J1827651"
}, - "RatingAgency": {
- "Id": 1,
- "Name": "Moody's"
}
}
Deletes an existing ESG component.
esgComponentId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Updates an existing ESG component.
esgComponentId required | integer <int32> ESG component Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Name | string Nullable |
Key | string Nullable |
Description | string Nullable |
MinScore | number <double> Nullable |
MaxScore | number <double> Nullable |
IsScoreAscending | boolean |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Key": "string",
- "Description": "string",
- "MinScore": 0,
- "MaxScore": 0,
- "IsScoreAscending": true
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Performs a health check of the system. Will return "OK" as "text/plain" if everything is working properly.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Returns system settings. If the optional group parameter is passed only settings for this group will be returned, otherwise all available settings.
group | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Key": "string",
- "Value": "string",
- "Group": "string"
}
]
Returns a specific system setting. The name of the group and the name of the key need to be supplied.
group required | string |
key required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Key": "string",
- "Value": "string",
- "Group": "string"
}
Returns campaign configuration data. Returns data about the active campaign of the tenant, including a list of product offers and their products, the list of supported languages and the default language. The language DTOs also contain specifications that can be used for number formatting (NumberDecimalSeparator and NumberGroupSeparator).
language required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ProductOffers": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Picture": "string",
- "IsActive": true,
- "ExternalId": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "ProductOfferType": {
- "Id": 0,
- "Name": "string"
}, - "Products": [
- {
- "Id": 0,
- "UId": "string",
- "ProductOfferId": 0,
- "OfferName": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "Fees": [
- {
- "FeeId": 0,
- "FeeDefinitionId": 0,
- "ValidFrom": "2024-12-18T16:13:42Z",
- "ValidTo": "2024-12-18T16:13:42Z",
- "FeeType": {
- "Id": 0,
- "Name": "string"
}, - "FeeRecurrenceType": {
- "Id": 0,
- "Name": "string"
}, - "IsPercentage": true,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
], - "DefaultOrderBookStatus": {
- "Key": "Reconciliation",
- "Id": 0,
- "Name": "string"
}, - "PortfolioRebalancingType": {
- "Key": "NoRebalancing",
- "Id": 0,
- "Name": "string"
}, - "OptimizationConstraintId": 0,
- "Settings": "string",
- "IsActive": true,
- "ContactType": {
- "Id": 0,
- "Name": "string"
}, - "ProductType": {
- "Key": "Advisory",
- "Id": 0,
- "Name": "string"
}
}
], - "Currencies": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
]
}
], - "Languages": [
- {
- "NumberDecimalSeparator": "string",
- "NumberGroupSeparator": "string",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "TwoLetterIsoCode": "string",
- "CultureCode": "string"
}
], - "DefaultLanguage": {
- "NumberDecimalSeparator": "string",
- "NumberGroupSeparator": "string",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "TwoLetterIsoCode": "string",
- "CultureCode": "string"
}, - "DefaultTimeZoneUtcOffsetMinutes": 0
}
Returns the list of all countries in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
]
Returns the list of all languages in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "TwoLetterIsoCode": "string",
- "CultureCode": "string"
}
]
Returns a list of all available data sources.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Name": "string",
- "CampaignId": 0,
- "OfferId": 0
}
]
Returns a list of stored procedures available for the provided data source and schema
dataSourceName required | string Name of the data source |
schema required | string Name of the specific DB schema |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Name": "string"
}
]
Returns the list of all risk categories.
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string",
- "UId": "string"
}
]
Creates a risk category.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Name | Array of objects (LocalizedValue) Nullable The Name of the risk category |
ExternalId | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": [
- {
- "LanguageCode": "string",
- "Value": "string"
}
], - "ExternalId": "string"
}
{- "Id": 0,
- "UId": "string"
}
Returns a risk cateogry by its id.
id required | integer <int32> The id of the risk category. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "ExternalId": "string",
- "UId": "string"
}
Returns the tree of all assetclasses in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Data": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Children": [
- { }
]
}
]
Returns the list of all continents in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
]
Returns the list of all securitytypes in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}
]
Returns the tree of all security sectors in the system.
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Data": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Children": [
- { }
]
}
]
Returns the list of all economical zones in the system.
language required | string Language value for xml fields |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
]
Return a economical zone by id
id required | integer <int32> Economical zone id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Color": "string"
}
Update existing economical zone
id required | integer <int32> Id of the existing economical zone |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the economical zone to update
Name required | string non-empty |
Color | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Color": "string"
}
{- "Id": 0,
- "Name": "string",
- "Color": "string"
}
Returns the list of all rating agencies.
language | string Language to translate the resources. If null, returns xml for all languages |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RatingAgencies": [
- {
- "Id": 0,
- "Name": "string",
- "Description": "string"
}
]
}
Creates a new rating agency.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Rating agency
Name | string Nullable |
Description | string Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Standard & Poor's",
- "Description": "<root><en>EN description</en><de>DE description</de></root>"
}
{- "Id": 0,
- "UId": "string"
}
Returns the list of all ratings for a rating agency.
ratingAgencyId required | integer <int32> Rating agency Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RatingAgencyId": 0,
- "Ratings": [
- {
- "Id": 0,
- "Value": "string",
- "Color": "string"
}
]
}
Creates a new rating for a rating agency.
ratingAgencyId required | integer <int32> Rating Agency Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Rating data
Value | string Nullable |
Color | string Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Value": "string",
- "Color": "string"
}
{- "Id": 0,
- "UId": "string"
}
Returns the different threshold types for orders.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "OrderThresholdTypes": [
- {
- "Key": "SharesAmount",
- "Id": 1,
- "Name": "Shares Amount"
}, - {
- "Key": "MoneyFixedAmount",
- "Id": 2,
- "Name": "Money Fixed Amount"
}, - {
- "Key": "RelativePortfolioAmount",
- "Id": 3,
- "Name": "Relative Portfolio Amount"
}, - {
- "Key": "RelativePortfolioPositionAmount",
- "Id": 4,
- "Name": "Relative Portfolio Position Amount"
}
]
}
Returns the list of all ESG components in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "EsgComponents": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Description": "string",
- "MinScore": 0,
- "MaxScore": 0,
- "IsScoreAscending": true
}
]
}
Creates a new ESG component.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Name | string Nullable |
Key | string Nullable |
Description | string Nullable |
MinScore | number <double> Nullable |
MaxScore | number <double> Nullable |
IsScoreAscending | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Key": "string",
- "Description": "string",
- "MinScore": 0,
- "MaxScore": 0,
- "IsScoreAscending": true
}
{- "Id": 0
}
Updates a risk category.
id required | integer <int32> The id of the risk category. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Name | Array of objects (LocalizedValue) Nullable The Name of the risk category |
ExternalId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": [
- {
- "LanguageCode": "string",
- "Value": "string"
}
], - "ExternalId": "string"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Updates an existing rating agency.
ratingAgencyId required | integer <int32> Rating agency Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
Name | string Nullable |
Description | string Nullable |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Description": "string",
- "UpdateProperties": [
- "string"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Updates an existing rating.
ratingAgencyId required | integer <int32> Rating agency Id |
ratingId required | integer <int32> Rating Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data
Value | string Nullable |
Color | string Nullable |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Value": "string",
- "Color": "string",
- "UpdateProperties": [
- "string"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Clears the cache which stores all the global settings.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Clears all caches
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Clears all cache entries with the key passed
key required | string The cache key. Can be appended by an asterisk (*) to indicate that all existing keys starting with this key should be deleted. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Publishes an integration event to the event bus
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Name required | string non-empty The actual name of the integration event. Since an event is something that happened in the past, the name of the event should be represented as a past-tense verb, like “OrderCreated”. |
Group | string Nullable An ID defining the group the integration event belongs to. This makes it easier to identify events that are all dealing with the same part of an application. An example would be “Ordering”. Not to be mistaken with the ContextId which identifies a unique context. |
ContextId | string Nullable Should contain a unique ID to identify the current context. It will be used to identify events belonging to the same context. |
Data | string Nullable The payload of the integration event serialized as JSON |
EntityName | string Nullable The optional entity name of the event bus. If not passed the default name 'DfsEventBus' will be used |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "OrderCreated",
- "Group": "Ordering",
- "ContextId": "12345",
- "Data": "{ 'ChangeSetId': 1 }"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Publishes a notification event to the service bus
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
PersonId | integer <int32> The ID of the person (contact ID or member ID) that is the recipient of the notification. |
Name required | string non-empty The actual name of the notification event. Since an event is something that happened in the past, the name of the event should be represented as a past-tense verb, like “MessageReceived”. |
Group | string Nullable An ID defining the group the notification event belongs to. This makes it easier to identify events that are all dealing with the same part of an application. An example would be “Messaging”. Not to be mistaken with the ContextId which identifies a unique context. |
ContextId | string Nullable Should contain a unique ID to identify the current context. It will be used to identify events belonging to the same context. |
Data | string Nullable The payload of the notification event serialized as JSON. Needs to contain the rendering data if template rendering is to be used to generate the notification texts. |
Subject | string Nullable The subject text of the notification. Needs to be set if template rendering is not to be used to generate the notification texts (Data is null). |
Text | string Nullable The body text of the notification. Needs to be set if template rendering is not to be used to generate the notification texts (Data is null). |
IsSystemNotification | boolean Indicates if the notification should be a system notification. Can only be set to true if template rendering is not used to generate the notification texts (Data is null and Subject and Text are set). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PersonId": 1,
- "Name": "MessageReceived",
- "Group": "Messaging",
- "ContextId": "12345",
- "Subject": "New message in your inbox",
- "Text": "Message text: test",
- "IsSystemNotification": false
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Create a new economical zone
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the economical zone to create
Name required | string non-empty |
Color | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Color": "string"
}
{- "Id": 0,
- "Name": "string",
- "Color": "string",
- "UId": "string"
}
Retrieves a list of enumerations for multiple tables. The tables available are:
AccountStatus, AccountTransactionStatus, AccountTransactionType, AccountType, BondCouponFrequency, ContactType, ContactAccessPolicy, CouponType, FeeRecurrenceType, FundingType, GoalType, IssuerType, ModelPortfolioAllocationType, ModelPortfolioOptimisationType, ModelPortfolioType, OptionExerciseType, OrderBookStatus, OrderThresholdType, OrderType, ParticipantRoleType, PortfolioChangeType, PortfolioProposalStatus, PortfolioRebalancingType, PortfolioStatus, PortfolioType, ProductType, QuestionnaireType, RecurrenceType, StockExchangeOrderType and StockExchangeOrderValidity
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data.
EnumerationTypes | Array of strings (EnumerationType) Nullable Items Enum: "AccountStatus" "AccountTransactionStatus" "AccountTransactionType" "AccountType" "BondCouponFrequency" "ContactType" "ContactAccessPolicy" "CouponType" "FeeRecurrenceType" "FundingType" "FundInvestmentType" "FundManagementType" "FundType" "GoalType" "IssuerType" "ModelPortfolioAllocationType" "ModelPortfolioOptimisationType" "ModelPortfolioType" "OptionExerciseType" "OrderBookStatus" "OrderThresholdType" "OrderType" "ParticipantRoleType" "PortfolioChangeType" "PortfolioProposalStatus" "PortfolioRebalancingType" "PortfolioStatus" "PortfolioType" "ProductType" "QuestionnaireType" "RecurrenceType" "StockExchangeOrderType" "StockExchangeOrderValidity" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "EnumerationTypes": [
- "AccountStatus",
- "AccountTransactionStatus",
- "AccountTransactionType",
- "AccountType",
- "BondCouponFrequency",
- "ContactType",
- "ContactAccessPolicy",
- "CouponType",
- "FundingType",
- "GoalType",
- "IssuerType",
- "ModelPortfolioAllocationType",
- "ModelPortfolioOptimisationType",
- "ModelPortfolioType",
- "OptionExerciseType",
- "OrderBookStatus",
- "OrderThresholdType",
- "OrderType",
- "ParticipantRoleType",
- "PortfolioChangeType",
- "PortfolioProposalStatus",
- "PortfolioRebalancingType",
- "PortfolioStatus",
- "PortfolioType",
- "ProductType",
- "QuestionnaireType",
- "RecurrenceType",
- "FeeRecurrenceType",
- "StockExchangeOrderType",
- "StockExchangeOrderValidity",
- "FundType",
- "FundManagementType",
- "FundInvestmentType"
]
}
{- "Enumerations": [
- {
- "Name": "AccountType",
- "Values": [
- {
- "Id": 1,
- "Name": "Cash",
- "Key": "Cash"
}, - {
- "Id": 2,
- "Name": "Custody",
- "Key": "Custody"
}, - {
- "Id": 3,
- "Name": "Savings",
- "Key": "Savings"
}, - {
- "Id": 4,
- "Name": "Settlement",
- "Key": "Settlement"
}, - {
- "Id": 5,
- "Name": "Deposit",
- "Key": "Deposit"
}
]
}
]
}
Retrieves a list of localized definitions for multiple tables. The tables available are:
EconomicalZone, FeeType, GoalStatus, InteractionTopic, InteractionType, ProductOfferType, RelativeType and Salutation
language | string Language to translate the resources. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data.
DefinitionTypes | Array of strings (DefinitionType) Nullable Items Enum: "EconomicalZone" "FeeType" "GoalStatus" "InteractionTopic" "InteractionType" "ProductOfferType" "RelativeType" "Salutation" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DefinitionTypes": [
- "EconomicalZone",
- "FeeType",
- "GoalStatus",
- "InteractionTopic",
- "InteractionType",
- "ProductOfferType",
- "RelativeType",
- "Salutation"
]
}
{- "Definitions": [
- {
- "Name": "FeeType",
- "Values": [
- {
- "Id": 1,
- "Name": "Management"
}, - {
- "Id": 2,
- "Name": "Platform"
}
]
}
]
}
Searches for country subdivisions and returns a list with country subdivisions (and key attributes) matching the passed request parameters (i.e. country two letter ISO codes). If no request parameters are passed then the entire list of country subdivisions (grouped by country) are returned.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
CountryTwoLetterIsoCodes | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CountryTwoLetterIsoCodes": [
- "DE",
- "CH",
- "US"
]
}
{- "CountriesSubdivisions": [
- {
- "Country": {
- "Id": 42,
- "TwoLetterIsoCode": "CH",
- "ThreeLetterIsoCode": "CHE"
}, - "Subdivisions": [
- {
- "Id": 2964,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Aargau",
- "IsoCode": "CH-AG"
}, - {
- "Id": 2965,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Appenzell Ausserrhoden",
- "IsoCode": "CH-AR"
}
]
}
]
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string"
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string"
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string",
- "LanguageId": 0,
- "Metadata": {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}, - "LastUpdateDate": "2024-12-18T16:13:42Z"
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
id required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "Metadatas": [
- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
}
Gets a collection of content artifacts (assets) by asset type
language required | string |
assetType | integer <int32> |
startRowIndex | integer <int32> |
pageSize | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Content": [
- {
- "Key": "string",
- "Value": "string",
- "AdditionalValue": "string"
}
]
}
]
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string"
}
]
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string"
}
]
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}
]
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string",
- "LanguageId": 0,
- "Metadata": {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}, - "LastUpdateDate": "2024-12-18T16:13:42Z"
}
]
key required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "Metadatas": [
- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "Metadatas": [
- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
}
]
metadataId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "Metadatas": [
- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
}
]
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
]
Receives an HTML template, a JSON object, renders the HTML, then generates the PDF from it
downloadFileName required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
html | string |
model | string |
pageOrientation | string (PageOrientation) Enum: "Portrait" "Landscape" |
header | string |
footer | string |
pageSize | string (PageSize) Enum: "A0" "A1" "A2" "A3" "A4" "A5" "A6" "A7" "A8" "A9" "A10" "B0" "B1" "B2" "B3" "B4" "B5" "ArchA" "ArchB" "ArchC" "ArchD" "ArchE" "Flsa" "HalfLetter" "Ledger" "Letter" "Note" "Letter11x17" "Legal" |
pageMarginTop | number <float> |
pageMarginLeft | number <float> |
pageMarginBottom | number <float> |
pageMarginRight | number <float> |
headerHeight | number <float> |
footerHeight | number <float> |
pageNumberStartIndex | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Receives an HTML template, a JSON object, renders the HTML, then generates the PDF from it
To introduce page numbering in footer or header, the following should be used:
Page number: &p;
Total number of pages: &P;
Example: Page &p; of &P; pages
downloadFileName required | string |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
html | string |
model | string |
pageOrientation | string (PageOrientation) Enum: "Portrait" "Landscape" |
header | string |
footer | string |
pageSize | string (PageSize) Enum: "A0" "A1" "A2" "A3" "A4" "A5" "A6" "A7" "A8" "A9" "A10" "B0" "B1" "B2" "B3" "B4" "B5" "ArchA" "ArchB" "ArchC" "ArchD" "ArchE" "Flsa" "HalfLetter" "Ledger" "Letter" "Note" "Letter11x17" "Legal" |
pageMarginTop | number <float> |
pageMarginLeft | number <float> |
pageMarginBottom | number <float> |
pageMarginRight | number <float> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Generates the document schema template using the specified parameters in the request.
Includes the schema, language, contentType, parameters, model and whether to include plain properties.Accept-Language | string The ISO 639-1 language to use for localizable data. |
SchemaId | integer <int32> Nullable |
SchemaKey | string Nullable |
LanguageId | integer <int32> |
ContentType | string Nullable |
Parameters | object Nullable |
Model | string Nullable |
IncludePlainProperties | boolean |
AdvancedProperties | object (GenerateRenderDocumentSchemaAdvancedPropertiesV10) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SchemaId": 0,
- "SchemaKey": "string",
- "LanguageId": 0,
- "ContentType": "string",
- "Parameters": {
- "property1": null,
- "property2": null
}, - "Model": "string",
- "IncludePlainProperties": true,
- "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string",
- "HeaderHeight": 0,
- "FooterHeight": 0,
- "PageNumberStartIndex": 0
}
}
{- "ContentType": "string",
- "Templates": [
- {
- "Base64Content": "string",
- "Model": null,
- "PlainProperties": {
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
}
]
}
Generates the document schema template using the specified parameters in the request.
Includes the schema, language, contentType, parameters, model and whether to include plain properties.Accept-Language | string The ISO 639-1 language to use for localizable data. |
SchemaId | integer <int32> Nullable |
SchemaKey | string Nullable |
LanguageId | integer <int32> |
ContentType | string Nullable |
Parameters | object Nullable |
Model | string Nullable |
IncludePlainProperties | boolean |
AdvancedProperties | object (GenerateRenderDocumentSchemaAdvancedProperties) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SchemaId": 0,
- "SchemaKey": "string",
- "LanguageId": 0,
- "ContentType": "string",
- "Parameters": {
- "property1": null,
- "property2": null
}, - "Model": "string",
- "IncludePlainProperties": true,
- "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
{- "ContentType": "string",
- "Templates": [
- {
- "Base64Content": "string",
- "Model": null,
- "PlainProperties": {
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
}
]
}
Generates a template using the specified parameters in the request.
Includes the metadata, language, contentType, parameters, model and whether to include plain properties.Accept-Language | string The ISO 639-1 language to use for localizable data. |
TemplateMetadataId | integer <int32> Nullable |
TemplateMetadataKey | string Nullable |
LanguageId | integer <int32> Nullable |
FallbackLanguageId | integer <int32> Nullable |
LanguageTwoLetterIsoCode | string Nullable |
FallbackLanguageTwoLetterIsoCode | string Nullable |
ContentType | string Nullable |
Parameters | object Nullable |
Model | string Nullable |
IncludePlainProperties | boolean |
IsPreview | boolean Nullable |
AdvancedProperties | object (GenerateRenderTemplateAdvancedPropertiesV11) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "TemplateMetadataId": 0,
- "TemplateMetadataKey": "string",
- "LanguageId": 0,
- "FallbackLanguageId": 0,
- "LanguageTwoLetterIsoCode": "string",
- "FallbackLanguageTwoLetterIsoCode": "string",
- "ContentType": "string",
- "Parameters": {
- "property1": null,
- "property2": null
}, - "Model": "string",
- "IncludePlainProperties": true,
- "IsPreview": true,
- "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string",
- "HeaderHeight": 0,
- "FooterHeight": 0,
- "PageNumberStartIndex": 0
}
}
{- "Base64Content": "string",
- "Model": null,
- "PlainProperties": {
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
}
Generates a template using the specified parameters in the request.
Includes the metadata, language, contentType, parameters, model and whether to include plain properties.Accept-Language | string The ISO 639-1 language to use for localizable data. |
TemplateMetadataId | integer <int32> Nullable |
TemplateMetadataKey | string Nullable |
LanguageId | integer <int32> Nullable |
FallbackLanguageId | integer <int32> Nullable |
LanguageTwoLetterIsoCode | string Nullable |
FallbackLanguageTwoLetterIsoCode | string Nullable |
ContentType | string Nullable |
Parameters | object Nullable |
Model | string Nullable |
IncludePlainProperties | boolean |
IsPreview | boolean Nullable |
AdvancedProperties | object (GenerateRenderTemplateAdvancedProperties) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "TemplateMetadataId": 0,
- "TemplateMetadataKey": "string",
- "LanguageId": 0,
- "FallbackLanguageId": 0,
- "LanguageTwoLetterIsoCode": "string",
- "FallbackLanguageTwoLetterIsoCode": "string",
- "ContentType": "string",
- "Parameters": {
- "property1": null,
- "property2": null
}, - "Model": "string",
- "IncludePlainProperties": true,
- "IsPreview": true,
- "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
{- "Base64Content": "string",
- "Model": null,
- "PlainProperties": {
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
}
Returns a preview of a generated template.
Includes the header, body, footer, contentType, pageOrientation, dataSet and parameters.Accept-Language | string The ISO 639-1 language to use for localizable data. |
AdvancedProperties | object (PdfOptionsV21) |
Header | string Nullable |
Body | string Nullable |
Footer | string Nullable |
ContentType | string Nullable |
PageOrientation | string (additiv.Dfs.Templating.Api.Common.Dto.PageOrientation) Enum: "Portrait" "Landscape" |
DataSetId | integer <int32> Nullable |
DataSourceParameters | object Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AdvancedProperties": {
- "PageOrientation": "string",
- "PageSize": "string",
- "PageNumberingStartIndex": 0,
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "HeaderHeight": 0,
- "FooterHeight": 0
}, - "Header": "string",
- "Body": "string",
- "Footer": "string",
- "ContentType": "string",
- "PageOrientation": "Portrait",
- "DataSetId": 0,
- "DataSourceParameters": {
- "property1": null,
- "property2": null
}
}
{- "Base64Content": "string",
- "Model": null,
- "PlainProperties": {
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
}
Returns a preview of a generated template.
Includes the header, body, footer, contentType, pageOrientation, dataSet and parameters.Accept-Language | string The ISO 639-1 language to use for localizable data. |
AdvancedProperties | object (PdfOptions) |
Header | string Nullable |
Body | string Nullable |
Footer | string Nullable |
ContentType | string Nullable |
PageOrientation | string (additiv.Dfs.Templating.Api.Common.Dto.PageOrientation) Enum: "Portrait" "Landscape" |
DataSetId | integer <int32> Nullable |
DataSourceParameters | object Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AdvancedProperties": {
- "PageOrientation": "Landscape",
- "PageSize": "A4",
- "PageMarginTop": 1,
- "PageMarginLeft": 1,
- "PageMarginBottom": 1,
- "PageMarginRight": 1
}, - "Header": "string",
- "Body": "string",
- "Footer": "string",
- "ContentType": "application/pdf",
- "PageOrientation": "Portrait",
- "DataSetId": 0,
- "DataSourceParameters": { }
}
{- "Base64Content": "string",
- "Model": null,
- "PlainProperties": {
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
Name | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string"
}
{- "Id": 0,
- "Name": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
Name | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string"
}
{- "Id": 0,
- "Name": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
StoredProcedure | string Nullable |
Alias | string Nullable |
ConnectionString | string Nullable |
InputParams | string Nullable |
IsCustom | boolean |
IsMultiLineResultSet | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}
{- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
CategoryId | integer <int32> |
DataSetId | integer <int32> Nullable |
ShowToCustomer | boolean |
Icon | string Nullable |
Key | string Nullable |
Name | string Nullable |
MemberId | integer <int32> |
Types | Array of integers <int32> Nullable |
SelectionParameters | Array of integers <int32> Nullable |
AdvancedProperties | object (CreateRenderTemplateAdvancedPropertiesV10) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "CategoryId": 0,
- "DataSetId": 0,
- "ShowToCustomer": true,
- "Icon": "string",
- "Key": "string",
- "Name": "string",
- "MemberId": 0,
- "Types": [
- 0
], - "SelectionParameters": [
- 0
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string",
- "HeaderHeight": 0,
- "FooterHeight": 0,
- "PageNumberStartIndex": 0
}
}
{- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string",
- "HeaderHeight": 0,
- "FooterHeight": 0,
- "PageNumberStartIndex": 0
}
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
CategoryId | integer <int32> |
DataSetId | integer <int32> Nullable |
ShowToCustomer | boolean |
Icon | string Nullable |
Key | string Nullable |
Name | string Nullable |
MemberId | integer <int32> |
Types | Array of integers <int32> Nullable |
SelectionParameters | Array of integers <int32> Nullable |
AdvancedProperties | object (CreateRenderTemplateAdvancedProperties) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "CategoryId": 0,
- "DataSetId": 0,
- "ShowToCustomer": true,
- "Icon": "string",
- "Key": "string",
- "Name": "string",
- "MemberId": 0,
- "Types": [
- 0
], - "SelectionParameters": [
- 0
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
{- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
LanguageId | integer <int32> |
MetadataId | integer <int32> |
Title | string Nullable |
Header | string Nullable |
Body | string Nullable |
Footer | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "LanguageId": 0,
- "MetadataId": 0,
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
{- "Id": 0,
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string",
- "LanguageId": 0,
- "Metadata": {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}, - "LastUpdateDate": "2024-12-18T16:13:42Z"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Name | string Nullable |
Key | string Nullable |
ShowToCustomer | boolean |
IsMerged | boolean |
TypeId | integer <int32> |
RenderTemplateMetadatas | Array of objects (OrderedRenderTemplateMetadataRequest) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "RenderTemplateMetadatas": [
- {
- "Id": 0,
- "Order": 0
}
]
}
{- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "Metadatas": [
- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
Name | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string"
}
{- "Id": 0,
- "Name": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
Name | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string"
}
{- "Id": 0,
- "Name": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
StoredProcedure | string Nullable |
Alias | string Nullable |
ConnectionString | string Nullable |
InputParams | string Nullable |
IsCustom | boolean |
IsMultiLineResultSet | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}
{- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
CategoryId | integer <int32> |
DataSetId | integer <int32> Nullable |
ShowToCustomer | boolean |
Icon | string Nullable |
Key | string Nullable |
Name | string Nullable |
MemberId | integer <int32> |
Types | Array of integers <int32> Nullable |
SelectionParameters | Array of integers <int32> Nullable |
AdvancedProperties | object (CreateRenderTemplateAdvancedPropertiesV10) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "CategoryId": 0,
- "DataSetId": 0,
- "ShowToCustomer": true,
- "Icon": "string",
- "Key": "string",
- "Name": "string",
- "MemberId": 0,
- "Types": [
- 0
], - "SelectionParameters": [
- 0
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string",
- "HeaderHeight": 0,
- "FooterHeight": 0,
- "PageNumberStartIndex": 0
}
}
{- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string",
- "HeaderHeight": 0,
- "FooterHeight": 0,
- "PageNumberStartIndex": 0
}
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
CategoryId | integer <int32> |
DataSetId | integer <int32> Nullable |
ShowToCustomer | boolean |
Icon | string Nullable |
Key | string Nullable |
Name | string Nullable |
MemberId | integer <int32> |
Types | Array of integers <int32> Nullable |
SelectionParameters | Array of integers <int32> Nullable |
AdvancedProperties | object (CreateRenderTemplateAdvancedProperties) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "CategoryId": 0,
- "DataSetId": 0,
- "ShowToCustomer": true,
- "Icon": "string",
- "Key": "string",
- "Name": "string",
- "MemberId": 0,
- "Types": [
- 0
], - "SelectionParameters": [
- 0
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
{- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
LanguageId | integer <int32> |
MetadataId | integer <int32> |
Title | string Nullable |
Header | string Nullable |
Body | string Nullable |
Footer | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "LanguageId": 0,
- "MetadataId": 0,
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string"
}
{- "Id": 0,
- "Title": "string",
- "Header": "string",
- "Body": "string",
- "Footer": "string",
- "LanguageId": 0,
- "Metadata": {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}, - "LastUpdateDate": "2024-12-18T16:13:42Z"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id | integer <int32> |
Name | string Nullable |
Key | string Nullable |
ShowToCustomer | boolean |
IsMerged | boolean |
TypeId | integer <int32> |
RenderTemplateMetadatas | Array of objects (OrderedRenderTemplateMetadataRequest) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "RenderTemplateMetadatas": [
- {
- "Id": 0,
- "Order": 0
}
]
}
{- "Id": 0,
- "Name": "string",
- "Key": "string",
- "ShowToCustomer": true,
- "IsMerged": true,
- "TypeId": 0,
- "Metadatas": [
- {
- "Id": 0,
- "UId": "string",
- "Category": {
- "Id": 0,
- "Name": "string"
}, - "DataSet": {
- "Id": 0,
- "StoredProcedure": "string",
- "Alias": "string",
- "ConnectionString": "string",
- "InputParams": "string",
- "IsCustom": true,
- "IsMultiLineResultSet": true
}, - "ShowToCustomer": true,
- "Icon": "string",
- "LastModifiedDate": "2024-12-18T16:13:42Z",
- "Key": "string",
- "Name": "string",
- "Order": 0,
- "Types": [
- {
- "Id": 0,
- "Name": "string"
}
], - "SelectionParameters": [
- {
- "Id": 0,
- "Name": "string",
- "SqlQuery": "string",
- "Comment": "string",
- "CreateDate": "2024-12-18T16:13:42Z",
- "LastModifiedDate": "2024-12-18T16:13:42Z"
}
], - "AdvancedProperties": {
- "PageMarginTop": 0,
- "PageMarginLeft": 0,
- "PageMarginBottom": 0,
- "PageMarginRight": 0,
- "PageSize": "string",
- "PageOrientation": "string"
}
}
]
}
Marks a message as deleted.
personId required | integer <int32> Person id who sent or received the message |
messageId required | integer <int64> Message identifier |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Retrieves a message by message id and person id. If the person is a contact then he must be either the sender or a recipient of the message and the list of the recipients is filtered by personId (if person is recipient). If the person is a member then all the recipients are retrieved and the message can be accessed by any member who has hierarchy access to the sender or to one of the recipients. The subject and the text of the message retrieved from the database are sanitized for better formatting.
personId required | integer <int32> The sender or the recipient identifier of the message or a member who has hierarchy access. |
messageId required | integer <int64> Message identifier |
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "SenderId": 1,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Zaria Jarvis",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:36.9507263Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 1,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Matt Davies",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 1,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file1.pdf",
- "DocumentId": "2011"
}, - {
- "FileName": "file2.txt",
- "DocumentId": "2012"
}
]
}
Retrieves a message attachment by person id, message id and document id. The attachment can be accessed by the sender, by one of the recipients or by a member who has hierarchy access.
personId required | integer <int32> The person identifier who is the owner of the document (sender or recipient or a member with hierarchy access). |
messageId required | integer <int64> The message identifier who contains the attachment. |
attachmentId required | integer <int32> The attachment identifier - externalId. This id identifies the document stored in DMS system. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "FileName": "TestFile.pdf",
- "Content": "CYl2",
- "DocumentId": "2001",
- "MimeType": "application/pdf"
}
Retrieves the message attachments by person id and message id. The attachments can be accessed by the sender, by one of the recipients or by a member who has hierarchy access.
personId required | integer <int32> The person identifier which is the owner of the document (sender or recipient or a member with hierarchy access). |
messageId required | integer <int64> The message identifier that contains the attachment. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "FileName": "string",
- "Content": "string",
- "DocumentId": "string",
- "MimeType": "string"
}
]
Retrieves the number of unread messages. If count is greater than 99 then return 99+
personId required | integer <int32> Person id who received the messages |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
"string"
Retrieves all types of messages that belong to a campaign.
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Subtypes": [
- {
- "Id": 0,
- "Name": "string"
}
]
}
]
Marks a message as read or unread.
personId required | integer <int32> Person id who sent or received the message. |
messageId required | integer <int64> Message identifier |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The payload containing the flag which marks the message as read or unread.
IsRead | boolean A flag to specify whether the message is read or not. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "IsRead": true
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143536.csv' was already imported on '12/17/2024 2:35:36 PM'."
}
]
}
}
Retrieves all messages of a contact grouped by threads. The endpoint can be accessed by the RM of the contact. The impersonation of the member should be allowed. Only the following filters are supported: PageNumber, PageSize, Text, TextLength, ThreadId, IsRead, IsDeleted, SenderIds, RecipientIds, PageNumber and PageSize. Sorting can be performed by the following columns: Id of thread, Id, CreateDate, Subject and CategoryName of person message. If the SenderIds filter is provided then it will be applied for the contactId as recipient. If the RecipientIds filter is provided then it will be applied for the contactId as sender. The messages from each thread are ordered descending.
contactId required | integer <int32> Contact id who sent or received the messages. |
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
A list of filters applied to messages like: text, isRead, isDeleted etc
ParticipantsIds | Array of integers <int32> Nullable Receives an array of PersonIds, and return all threads that have any of these IDs in the SenderId or RecipientId in the first message of the thread. |
CreatedByIds | Array of integers <int32> Nullable Receives an array of PersonIds, and return all threads that have any of these IDs in the SenderId in the first message of the thread. |
StartDate | string <date-time> Nullable |
EndDate | string <date-time> Nullable |
ThreadId | integer <int32> Nullable |
IsRead | boolean Nullable |
IsDeleted | boolean Nullable |
Text | string Nullable |
TextLength | integer <int32> Nullable Number of characters returned from the body of each message. Enter 0 to return unlimited characters (full body of each message) |
SortColumn | string Nullable Sorting is possible by SubTypeId, CreateDate and Subject fields |
SortOrder | string Nullable |
SubtypeIds | Array of integers <int32> Nullable |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ParticipantsIds": [
- 2
], - "CreatedByIds": [
- 23
], - "StartDate": "2024-12-17T14:35:37.0003207Z",
- "EndDate": "2024-12-18T14:35:37.0003217Z",
- "ThreadId": 1,
- "IsRead": false,
- "IsDeleted": false,
- "Text": "football",
- "TextLength": 10,
- "SortColumn": "Id",
- "SortOrder": "desc",
- "SubtypeIds": [
- 1
], - "PageNumber": 1,
- "PageSize": 10
}
{- "Data": [
- {
- "ThreadId": 1,
- "Messages": [
- {
- "Id": 1,
- "SenderId": 1,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Zaria Jarvis",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0004532Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false
}
]
}, - {
- "Id": 2,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0004572Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Zaria Jarvis",
- "IsRead": false,
- "IsDeleted": false
}
], - "Attachments": [
- {
- "FileName": "file1.pdf",
- "DocumentId": "2011"
}, - {
- "FileName": "file2.txt",
- "DocumentId": "2012"
}
]
}
]
}, - {
- "ThreadId": 2,
- "Messages": [
- {
- "Id": 3,
- "SenderId": 1,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Zaria Jarvis",
- "SenderPersonType": "Contact",
- "Subject": "Sprint review",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0004587Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Joe Doe",
- "IsRead": false,
- "IsDeleted": false
}
]
}
]
}
], - "PageCount": 1,
- "Total": 2,
- "PageNumber": 1,
- "PageSize": 10
}
Retrieves all messages of a member that he has access to directly (sender or recipient) or through hierarchy access from other members. The messages are grouped by threads. The endpoint can be accessed by the RM of the contact. The impersonation of the member should be allowed. The following filters are supported: PageNumber, PageSize, Text, TextLength, ThreadId, IsRead, IsDeleted, SenderIds, RecipientIds, PageNumber and PageSize. Sorting can be performed by the following columns: Id of thread, Id, CreateDate, Subject and CategoryName of person message. If the SenderIds filter is provided then it should contain only the member ids from the hierarchy of the member. The final filter will contain the memberIds + direct their contacts + sendersIds which are not of type member. If the RecipientIds filter is provided then it should contain only the member ids from the hierarchy of the member. The final filter will contain the memberIds + direct their contacts + recipientIds which are not of type member. The messages from each thread are ordered descending.
memberId required | integer <int32> Member id who sent or received the messages or has access to other members. |
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
A list of filters applied to messages like: text, senderIds, recipientIds etc
ParticipantsIds | Array of integers <int32> Nullable Receives an array of PersonIds, and return all threads that have any of these IDs in the SenderId or RecipientId in the first message of the thread |
CreatedByIds | Array of integers <int32> Nullable Receives an array of PersonIds, and return all threads that have any of these IDs in the SenderId in the first message of the thread. |
DateFrom | string <date-time> Nullable The first message in the thread was sent after this date. |
DateTo | string <date-time> Nullable The last message in the thread was sent before this date. |
SubtypeIds | Array of integers <int32> Nullable The first message of the thread has one of the specified subTypeIds. |
StartDate | string <date-time> Nullable |
EndDate | string <date-time> Nullable |
ThreadId | integer <int32> Nullable |
IsRead | boolean Nullable |
IsDeleted | boolean Nullable |
Text | string Nullable |
TextLength | integer <int32> Nullable Number of characters returned from the body of each message. Enter 0 to return unlimited characters (full body of each message) |
SortColumn | string Nullable Sorting is possible by SubTypeId, CreateDate and Subject fields |
SortOrder | string Nullable |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ParticipantsIds": [
- 2
], - "CreatedByIds": [
- 23
], - "DateFrom": "2024-12-17T14:35:37.0036754Z",
- "DateTo": "2024-12-18T14:35:37.0036757Z",
- "SubtypeIds": [
- 1
], - "StartDate": "2024-12-17T14:35:37.0036731Z",
- "EndDate": "2024-12-18T14:35:37.0036735Z",
- "ThreadId": 1,
- "IsRead": false,
- "IsDeleted": false,
- "Text": "football",
- "TextLength": 10,
- "SortColumn": "Id",
- "SortOrder": "desc",
- "PageNumber": 1,
- "PageSize": 10
}
{- "Data": [
- {
- "ThreadId": 1,
- "Messages": [
- {
- "Id": 1,
- "SenderId": 1,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Zaria Jarvis",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0041137Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false
}
]
}, - {
- "Id": 2,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0041162Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Zaria Jarvis",
- "IsRead": false,
- "IsDeleted": false
}
], - "Attachments": [
- {
- "FileName": "file1.pdf",
- "DocumentId": "2011"
}, - {
- "FileName": "file2.txt",
- "DocumentId": "2012"
}
]
}
]
}, - {
- "ThreadId": 2,
- "Messages": [
- {
- "Id": 3,
- "SenderId": 1,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Zaria Jarvis",
- "SenderPersonType": "Contact",
- "Subject": "Sprint review",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0041294Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Joe Doe",
- "IsRead": false,
- "IsDeleted": false
}
]
}
]
}
], - "PageCount": 1,
- "Total": 2,
- "PageNumber": 1,
- "PageSize": 10
}
Retrieves messages sent to or by the specified contact. Further filtering supports retrieving �inbox� and �outbox� lists.
contactId required | integer <int32> Contact id who sent or received the messages. |
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
A list of filters applied to messages like: text for search, createDate, isRead, isDeleted etc
StartDate | string <date-time> Nullable |
EndDate | string <date-time> Nullable |
ThreadId | integer <int32> Nullable |
IsRead | boolean Nullable |
IsDeleted | boolean Nullable |
Text | string Nullable |
TextLength | integer <int32> Nullable Number of characters returned from the body of each message. Enter 0 to return unlimited characters (full body of each message) |
SortColumn | string Nullable Sorting is possible by SubTypeId, CreateDate and Subject fields |
SortOrder | string Nullable |
SenderIds | Array of integers <int32> Nullable |
RecipientIds | Array of integers <int32> Nullable |
SubtypeIds | Array of integers <int32> Nullable |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "StartDate": "2024-12-17T14:35:37.0065071Z",
- "EndDate": "2024-12-18T14:35:37.0065075Z",
- "ThreadId": 1,
- "IsRead": false,
- "IsDeleted": false,
- "Text": "football",
- "TextLength": 10,
- "SortColumn": "Id",
- "SortOrder": "desc",
- "SenderIds": [
- 1,
- 2
], - "RecipientIds": [
- 3,
- 4
], - "SubtypeIds": [
- 1
], - "PageNumber": 1,
- "PageSize": 10
}
{- "Data": [
- {
- "Id": 1,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0065736Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 1,
- "CampaignId": 1
}
]
}, - {
- "Id": 2,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Next release",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-15T14:35:37.0065749Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 2,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Daren Jones",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 2,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file1.pdf",
- "DocumentId": "2011"
}, - {
- "FileName": "file2.txt",
- "DocumentId": "2012"
}
]
}, - {
- "Id": 3,
- "SenderId": 3,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "James Moore",
- "SenderPersonType": "Contact",
- "Subject": "Delivery report",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0065758Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}, - {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Daren Jones",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file5.pdf",
- "DocumentId": "2013"
}
]
}
], - "PageCount": 1,
- "Total": 3,
- "PageNumber": 1,
- "PageSize": 10
}
Retrieves the messages that a member has access to through Hierarchy Access.
memberId required | integer <int32> The member who has access to through Hierarchy Access. |
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
A list of filters applied to messages like: text for search, CreateDate, IsActive, IsRead, IsDelete
SenderType | integer <int32> Nullable |
ContactType | integer <int32> Nullable |
StartDate | string <date-time> Nullable |
EndDate | string <date-time> Nullable |
ThreadId | integer <int32> Nullable |
IsRead | boolean Nullable |
IsDeleted | boolean Nullable |
Text | string Nullable |
TextLength | integer <int32> Nullable Number of characters returned from the body of each message. Enter 0 to return unlimited characters (full body of each message) |
SortColumn | string Nullable Sorting is possible by SubTypeId, CreateDate and Subject fields |
SortOrder | string Nullable |
SenderIds | Array of integers <int32> Nullable |
RecipientIds | Array of integers <int32> Nullable |
SubtypeIds | Array of integers <int32> Nullable |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SenderType": 2,
- "ContactType": 1,
- "StartDate": "2024-12-17T14:35:37.0097538Z",
- "EndDate": "2024-12-18T14:35:37.0097541Z",
- "ThreadId": 1,
- "IsRead": false,
- "IsDeleted": false,
- "Text": "football",
- "TextLength": 10,
- "SortColumn": "Id",
- "SortOrder": "desc",
- "SenderIds": [
- 1,
- 2
], - "RecipientIds": [
- 3,
- 4
], - "SubtypeIds": [
- 1
], - "PageNumber": 1,
- "PageSize": 10
}
{- "Data": [
- {
- "Id": 1,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0098241Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 1,
- "CampaignId": 1
}
]
}, - {
- "Id": 2,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Next release",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-15T14:35:37.0098252Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 2,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Daren Jones",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 2,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file1.pdf",
- "DocumentId": "2011"
}, - {
- "FileName": "file2.txt",
- "DocumentId": "2012"
}
]
}, - {
- "Id": 3,
- "SenderId": 3,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "James Moore",
- "SenderPersonType": "Contact",
- "Subject": "Delivery report",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0098391Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}, - {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Daren Jones",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file5.pdf",
- "DocumentId": "2013"
}
]
}
], - "PageCount": 1,
- "Total": 3,
- "PageNumber": 1,
- "PageSize": 10
}
Retrieves messages sent to or by the specified member. Further filtering supports retrieving �inbox� and �outbox� lists.
memberId required | integer <int32> Member id who sent or received the messages. |
language | string Language |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
A list of filters applied to messages like: text for search, createDate, isRead, isDeleted etc
SenderType | integer <int32> Nullable |
ContactType | integer <int32> Nullable |
StartDate | string <date-time> Nullable |
EndDate | string <date-time> Nullable |
ThreadId | integer <int32> Nullable |
IsRead | boolean Nullable |
IsDeleted | boolean Nullable |
Text | string Nullable |
TextLength | integer <int32> Nullable Number of characters returned from the body of each message. Enter 0 to return unlimited characters (full body of each message) |
SortColumn | string Nullable Sorting is possible by SubTypeId, CreateDate and Subject fields |
SortOrder | string Nullable |
SenderIds | Array of integers <int32> Nullable |
RecipientIds | Array of integers <int32> Nullable |
SubtypeIds | Array of integers <int32> Nullable |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SenderType": 2,
- "ContactType": 1,
- "StartDate": "2024-12-17T14:35:37.0126204Z",
- "EndDate": "2024-12-18T14:35:37.0126209Z",
- "ThreadId": 1,
- "IsRead": false,
- "IsDeleted": false,
- "Text": "football",
- "TextLength": 10,
- "SortColumn": "Id",
- "SortOrder": "desc",
- "SenderIds": [
- 1,
- 2
], - "RecipientIds": [
- 3,
- 4
], - "SubtypeIds": [
- 1
], - "PageNumber": 1,
- "PageSize": 10
}
{- "Data": [
- {
- "Id": 1,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Important meeting",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0129217Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 1,
- "CampaignId": 1
}
]
}, - {
- "Id": 2,
- "SenderId": 1001,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "Jamarcus Fuentes",
- "SenderPersonType": "Contact",
- "Subject": "Next release",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-15T14:35:37.0129259Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 2,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Daren Jones",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 2,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file1.pdf",
- "DocumentId": "2011"
}, - {
- "FileName": "file2.txt",
- "DocumentId": "2012"
}
]
}, - {
- "Id": 3,
- "SenderId": 3,
- "SenderUId": "00000000-0000-0000-0000-000000000000",
- "SenderFullName": "James Moore",
- "SenderPersonType": "Contact",
- "Subject": "Delivery report",
- "IsRead": false,
- "IsDeleted": false,
- "CreateDate": "2024-12-18T14:35:37.0129273Z",
- "SubtypeId": 0,
- "Recipients": [
- {
- "RecipientId": 1,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Member",
- "FullName": "Maria Jarvis",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}, - {
- "RecipientId": 1001,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Jamarcus Fuentes",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}, - {
- "RecipientId": 1002,
- "RecipientUId": "00000000-0000-0000-0000-000000000000",
- "RecipientPersonType": "Contact",
- "FullName": "Daren Jones",
- "IsRead": false,
- "IsDeleted": false,
- "ThreadId": 3,
- "CampaignId": 1
}
], - "Attachments": [
- {
- "FileName": "file5.pdf",
- "DocumentId": "2013"
}
]
}
], - "PageCount": 1,
- "Total": 3,
- "PageNumber": 1,
- "PageSize": 10
}
Sends a new message to all RMs of a specific contact.
contactId required | integer <int32> Contact id who sends the message. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Send message parameter
SubtypeId | integer <int32> The subtype identifier of the message. |
CustomAttributes | string Nullable The custom attributes of the message represented as json. |
Subject | string Nullable The subject of the message. It will be sanitized in order to avoid XSS attacks. |
Text | string Nullable The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
Attachments | Array of objects (MessageAttachment) Nullable The list of the message attachments (file name and content of the file). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SubtypeId": 1,
- "CustomAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
- "Subject": "2018 FIFA WORLD CUP RUSSIA",
- "Text": "The 2018 FIFA World Cup is the 21st FIFA World Cup, a quadrennial international football tournament contested by the men's national teams of the member associations of FIFA",
- "Attachments": [
- {
- "FileName": "file1.pdf",
- "Content": "UZhx"
}, - {
- "FileName": "file2.pdf",
- "Content": "IZgx"
}
]
}
{- "Result": "Success",
- "RemovedElements": [
- "tag"
], - "MessageId": 1,
- "MessageThreadId": 1
}
Sends a new message to a specific member.
contactId required | integer <int32> Contact id who sends the message. |
memberId required | integer <int32> Member id who receives the message. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Send message parameter
SubtypeId | integer <int32> The subtype identifier of the message. |
CustomAttributes | string Nullable The custom attributes of the message represented as json. |
Subject | string Nullable The subject of the message. It will be sanitized in order to avoid XSS attacks. |
Text | string Nullable The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
Attachments | Array of objects (MessageAttachment) Nullable The list of the message attachments (file name and content of the file). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SubtypeId": 1,
- "CustomAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
- "Subject": "2018 FIFA WORLD CUP RUSSIA",
- "Text": "The 2018 FIFA World Cup is the 21st FIFA World Cup, a quadrennial international football tournament contested by the men's national teams of the member associations of FIFA",
- "Attachments": [
- {
- "FileName": "file1.pdf",
- "Content": "UZhx"
}, - {
- "FileName": "file2.pdf",
- "Content": "IZgx"
}
]
}
{- "Result": "Success",
- "RemovedElements": [
- "tag"
], - "MessageId": 1,
- "MessageThreadId": 1
}
Sends a new message to a subset of recipients. The list of the recipients is mandatory.
memberId required | integer <int32> Member identifier who sends the message. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Send message parameter including the list of the recipients.
RecipientIds | Array of integers <int32> Nullable The person identifiers who receive the message. The recipients can be both contacts and members. The message will be sent to all recipients. |
SubtypeId | integer <int32> The subtype identifier of the message. |
CustomAttributes | string Nullable The custom attributes of the message represented as json. |
Subject | string Nullable The subject of the message. It will be sanitized in order to avoid XSS attacks. |
Text | string Nullable The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
Attachments | Array of objects (MessageAttachment) Nullable The list of the message attachments (file name and content of the file). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RecipientIds": [
- 1,
- 2,
- 3,
- 1001,
- 1002
], - "SubtypeId": 1,
- "CustomAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
- "Subject": "2018 FIFA WORLD CUP RUSSIA",
- "Text": "The 2018 FIFA World Cup is the 21st FIFA World Cup, a quadrennial international football tournament contested by the men's national teams of the member associations of FIFA",
- "Attachments": [
- {
- "FileName": "file1.pdf",
- "Content": "UZhx"
}, - {
- "FileName": "file2.pdf",
- "Content": "IZgx"
}
]
}
{- "Result": "Success",
- "RemovedElements": [
- "tag"
], - "MessageId": 1,
- "MessageThreadId": 1
}
Replies with a new message to a sender of a given message.
personId required | integer <int32> The person recipient of the original message or the sender of the new message. |
messageId required | integer <int64> The original message identifier. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Reply message parameter.
Subject | string Nullable The subject of the message. It will be sanitized in order to avoid XSS attacks. |
Text | string Nullable The content/text body of the message. It will be sanitized in order to avoid XSS attacks. |
Attachments | Array of objects (MessageAttachment) Nullable The list of the message attachments (file name and content of the file). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Subject": "2018 FIFA WORLD CUP RUSSIA",
- "Text": "The 2018 FIFA World Cup is the 21st FIFA World Cup, a quadrennial international football tournament contested by the men's national teams of the member associations of FIFA",
- "Attachments": [
- {
- "FileName": "file1.pdf",
- "Content": "UZhx"
}, - {
- "FileName": "file2.pdf",
- "Content": "IZgx"
}
]
}
{- "Result": "Success",
- "RemovedElements": [
- "tag"
], - "MessageId": 1,
- "MessageThreadId": 1
}
Retrieves calculated and chosen risk for the contact and for the groups that the specific contact is part of.
This API is deprecated. Use GET /v2.0/contacts/{contactId}/chosen-risk instead.
contactId required | integer <int32> The id of the contact |
language | string The language of the localized resources. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CalculatedRiskCategory": {
- "Id": 5,
- "Name": "Moderate",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "ChosenRiskCategory": {
- "Id": 5,
- "Name": "Moderate",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "GroupsRiskCategories": [
- {
- "ContactGroupId": 15,
- "CalculatedRiskCategory": {
- "Id": 5,
- "Name": "Moderate",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "ChosenRiskCategory": {
- "Id": 5,
- "Name": "Moderate",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}
}, - {
- "ContactGroupId": 16,
- "CalculatedRiskCategory": {
- "Id": 3,
- "Name": "Balanced",
- "UId": "c38aa5a8-e064-4cd5-8026-4f6cc39cbddd"
}, - "ChosenRiskCategory": {
- "Id": 2,
- "Name": "Conservative",
- "UId": "6c67d377-98a6-4e46-8a71-093faca3408b"
}
}
]
}
Retrieves contact questionnaires. Risk profiling questionnaires will include risk result information as well as a potential expiration date, while knowledge and experience questionnaires will include investment constraints generated from the submission. Expired questionnaires may be returned if a new submission was not made.
contactId required | integer <int32> The id of the contact |
questionnaireTypeId | integer <int32> Filter questionnaires by questionnaire type |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Questionnaires": [
- {
- "QuestionnaireId": 10,
- "Name": "RiskProfileQuestionnaire1",
- "QuestionnaireTypeId": 1,
- "SubmissionId": 1,
- "SubmissionDate": "2024-12-18T14:35:37.0307388+00:00",
- "ExpiryDate": "2025-01-18T14:35:37.0307396+00:00",
- "CalculatedProductRiskCategories": [
- {
- "ProductId": 1,
- "IsAccepted": true,
- "RiskCategory": {
- "Id": 5,
- "Name": "Moderate",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "ScoreRangePercentage": 2.8,
- "Groups": [
- {
- "Key": "X121234",
- "Name": "Balanced",
- "RiskCategory": {
- "Id": 1,
- "Name": "Balanced",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "ScoreRangePercentage": 56.7
}
]
}, - {
- "ProductId": 2,
- "IsAccepted": false,
- "RiskCategory": {
- "Id": 5,
- "Name": "Moderate",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "ScoreRangePercentage": 4.7,
- "Groups": [
- {
- "Key": "X121234",
- "Name": "Balanced",
- "RiskCategory": {
- "Id": 1,
- "Name": "Balanced",
- "UId": "2e2a9eb4-dc16-498f-8f5f-2fe8c3869dbc"
}, - "ScoreRangePercentage": 43.7
}
]
}
], - "InvestmentConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 1
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 1
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 1
}, - "MinWeight": 0,
- "MaxWeight": 1
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "MinWeight": 0,
- "MaxWeight": 1
}
]
}
}
]
}
Submits contact questionnaire. For each question, depending on the question-type, either answerIds or answerText should be supplied. Note the following:
Possible ApiError.SubCode values:
QuestionnaireNoLongerValid: The submitted questionnaire is no longer the latest version of that questionnaire.
contactId required | integer <int32> The contact identifier for which the questionnaire is passed. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The questionnaire passed in full, regardless of it being complete or not in terms of answered questions.
QuestionnaireId | integer <int32> |
ConcurrencyToken | integer <int64> |
Groups | Array of objects (QuestionGroup) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "QuestionnaireId": 0,
- "ConcurrencyToken": 0,
- "Groups": [
- {
- "Id": 0,
- "Questions": [
- {
- "Id": 0,
- "AnswerIds": [
- 0
], - "AnswerText": "string"
}
]
}
]
}
{- "IsComplete": false,
- "IncompleteGroups": [
- {
- "Id": 1,
- "IncompleteQuestionIds": [
- 22,
- 27
]
}
]
}
Retrieves questionnaire by id. If questionnaire is disabled, use the search endpoint to find an alternative for the needed products/contact-type/questionnaire-type.
Possible ApiError.SubCode values:
QuestionnaireDisabled: Questionnaire disabled and may not be returned to the user.
questionnaireId required | integer <int32> The id of the questionnaire |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string",
- "ContactTypeId": 0,
- "ProductIds": [
- 0
], - "QuestionnaireTypeId": 0,
- "Groups": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Title": "string",
- "Description": "string",
- "Steps": [
- {
- "Id": 0,
- "Name": "string",
- "Title": "string",
- "Description": "string",
- "Questions": [
- {
- "Id": 0,
- "Type": "string",
- "Layout": "string",
- "Formatter": "string",
- "MinimumNumberOfAnswers": 0,
- "MaximumNumberOfAnswers": 0,
- "RangeStep": 0,
- "MinimumRange": 0,
- "MaximumRange": 0,
- "ValidationRule": "string",
- "Text": "string",
- "Title": "string",
- "TextInputMask": "string",
- "TextLength": 0,
- "Image": "string",
- "Order": 0,
- "Answers": [
- {
- "Id": 0,
- "Key": "string",
- "Text": "string",
- "Description": "string",
- "Header": "string",
- "Image": "string",
- "Order": 0,
- "FollowupStep": { }
}
], - "Value": {
- "Ids": [
- 0
], - "Value": "string"
}
}
]
}
], - "Score": 0
}
], - "ConcurrencyToken": 0
}
Returns contact questionnaire submission by submission-id, along with the full questionnaire information.
contactId required | integer <int32> The id of the contact |
submissionId required | integer <int32> The id of the questionnaire submission |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string",
- "ProductIds": [
- 0
], - "Groups": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Title": "string",
- "Description": "string",
- "Steps": [
- {
- "Id": 0,
- "Name": "string",
- "Title": "string",
- "Description": "string",
- "Questions": [
- {
- "Id": 0,
- "Type": "string",
- "Layout": "string",
- "Formatter": "string",
- "MinimumNumberOfAnswers": 0,
- "MaximumNumberOfAnswers": 0,
- "RangeStep": 0,
- "MinimumRange": 0,
- "MaximumRange": 0,
- "ValidationRule": "string",
- "Text": "string",
- "Title": "string",
- "TextInputMask": "string",
- "TextLength": 0,
- "Image": "string",
- "Order": 0,
- "Answers": [
- {
- "Id": 0,
- "Key": "string",
- "Text": "string",
- "Description": "string",
- "Header": "string",
- "Image": "string",
- "Order": 0,
- "FollowupStep": { }
}
], - "Value": {
- "Ids": [
- 0
], - "Value": "string"
}
}
]
}
], - "Score": 0
}
]
}
Returns the risk profile associated with the user's last complete/incomplete questionnaire. If the contact has no questionnaire available, a validation exception will be returned. If a groupKey is specified, only the risk details for that group are returned. If riskAccepted is set to false, the risk will not be automatically assigned to the contact (the client would need to POST to contacts/acceptrisk separately in order to make this association) This API is deprecated. Use POST v2.0/contacts/{contactId}/questionnaires/calculate-risk instead.
contactId required | integer <int32> The id of the contact |
productId required | integer <int32> The id of the product |
completeQuestionnaire required | boolean The flag which specifies whether the questionnaire is completed or not |
riskAccepted required | boolean The flag which specifies whether the risk will be automatically assigned to the contact or not. |
language required | string The language of the questionnaire |
groupKey | string The key of the group for which risk details are returned |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Score": 20,
- "RiskCategory": {
- "Id": 3,
- "Name": "Balanced",
- "Min": 6,
- "Max": 11,
- "ExpectedReturn": 4.2,
- "UId": "c38aa5a8-e064-4cd5-8026-4f6cc39cbddd"
}, - "Groups": [
- {
- "Key": "BFHNJ7I86A",
- "Name": "Risk Appetite",
- "Score": 18,
- "RiskCategory": {
- "Id": 3,
- "Name": "Balanced",
- "Min": 6,
- "Max": 11,
- "ExpectedReturn": 4.2,
- "UId": "c38aa5a8-e064-4cd5-8026-4f6cc39cbddd"
}
}
]
}
Returns contact-level chosen risk category.
contactId required | integer <int32> The id of the contact |
language | string The language of the localized resources. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RiskCategory": {
- "Id": 1,
- "Name": "Moderate",
- "UId": "8593b96b-0693-4234-870b-40ba0b34c64e"
}
}
Updates contact-level chosen risk category.
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request with id of the risk category that will be set to the contact
RiskCategoryId required | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RiskCategoryId": 0
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets the constraints of a contact.
contactId required | integer <int32> The ID of the contact |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Returns all active questionnaires filtered by the optional parameters. If 'productId' is not passed, the results include only questionnaires that are not associated with any product. If 'ContactTypeId' is not passed, the results include questionnaires of both types (privates, corporates). If 'QuestionnaireTypeId' is not passed, the results include questionnaires of all questionnaire types available. Some answers might have follow-up steps which should translate into the client having to present an additional group of questions if that specific answer was picked by the contact.
This API is deprecated. Use POST /v2.0/questionnaires/search instead.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Language required | string non-empty The returned language of the questionnaire's resources |
ProductId | integer <int32> Nullable The id of the product related to a questionnaire |
ContactTypeId | integer <int32> Nullable The id of the contact type related to a questionnaire |
QuestionnaireTypeId | integer <int32> Nullable The id of the questionnaire type related to a questionnaire |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Language": "en",
- "ProductId": 1,
- "ContactTypeId": 1,
- "QuestionnaireTypeId": 1
}
[- {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "ContactTypeId": 0,
- "ContactTypeName": "string",
- "ProductId": 0,
- "QuestionnaireTypeId": 0,
- "Groups": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Title": "string",
- "Description": "string",
- "Steps": [
- {
- "Id": 0,
- "Name": "string",
- "Title": "string",
- "Description": "string",
- "Questions": [
- {
- "Id": 0,
- "Type": "string",
- "Layout": "string",
- "Formatter": "string",
- "MinimumNumberOfAnswers": 0,
- "MaximumNumberOfAnswers": 0,
- "RangeStep": 0,
- "MinimumRange": 0,
- "MaximumRange": 0,
- "ValidationRule": "string",
- "Text": "string",
- "Title": "string",
- "TextInputMask": "string",
- "TextLength": 0,
- "Image": "string",
- "Order": 0,
- "Answers": [
- {
- "Id": 0,
- "Key": "string",
- "Text": "string",
- "Description": "string",
- "Header": "string",
- "Image": "string",
- "Order": 0,
- "FollowupStep": { }
}
], - "Value": {
- "Ids": [
- 0
], - "Value": "string"
}
}
]
}
], - "Score": 0
}
]
}
]
Retrieve questionnaires according to the specified filters. Note the following:
Accept-Language | string The ISO 639-1 language to use for localizable data. |
ProductIds | Array of integers <int32> Nullable |
ContactTypeId | integer <int32> Nullable |
QuestionnaireTypeId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ProductIds": [
- 0
], - "ContactTypeId": 0,
- "QuestionnaireTypeId": 0
}
{- "Results": [
- {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "ContactTypeId": 0,
- "ProductIds": [
- 0
], - "QuestionnaireTypeId": 0,
- "Groups": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Title": "string",
- "Description": "string",
- "Steps": [
- {
- "Id": 0,
- "Name": "string",
- "Title": "string",
- "Description": "string",
- "Questions": [
- {
- "Id": 0,
- "Type": "string",
- "Layout": "string",
- "Formatter": "string",
- "MinimumNumberOfAnswers": 0,
- "MaximumNumberOfAnswers": 0,
- "RangeStep": 0,
- "MinimumRange": 0,
- "MaximumRange": 0,
- "ValidationRule": "string",
- "Text": "string",
- "Title": "string",
- "TextInputMask": "string",
- "TextLength": 0,
- "Image": "string",
- "Order": 0,
- "Answers": [
- {
- "Id": 0,
- "Key": "string",
- "Text": "string",
- "Description": "string",
- "Header": "string",
- "Image": "string",
- "Order": 0,
- "FollowupStep": { }
}
], - "Value": {
- "Ids": [
- 0
], - "Value": "string"
}
}
]
}
], - "Score": 0
}
], - "ConcurrencyToken": 0
}
]
}
Stores either a complete or an incomplete questionnaire. The questionnaire should be passed in full, regardless of it being complete or not in terms of answered questions. Each of the answered questions should have either a list of Ids (for single/multi-answer questions) or a Value (for free-text questions) as Value. The response will state whether or not the questionnaire was complete in terms of each question having an answer and, if not, include details as to which QuestionIds caused the questionnaire to be deemed as incomplete. The response can also be a validation exception (HTTP 422) but only if the answer type does not match the question type (e.g.: multiple answers for a single answer type question) or if the answerIds provided are not part the question's answers.
This API is deprecated. Use POST /v2.0/contacts/{contactId}/questionnaires instead.
contactId required | integer <int32> The contact identifier for which the questionnaire is passed. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The questionnaire passed in full, regardless of it being complete or not in terms of answered questions.
Id | integer <int32> |
Name | string Nullable |
Description | string Nullable |
ContactTypeId | integer <int32> Nullable |
ContactTypeName | string Nullable |
ProductId | integer <int32> Nullable |
QuestionnaireTypeId | integer <int32> Nullable |
Groups | Array of objects (Questionnaire.Abstractions.Dto.QuestionGroup) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string",
- "ContactTypeId": 0,
- "ContactTypeName": "string",
- "ProductId": 0,
- "QuestionnaireTypeId": 0,
- "Groups": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Title": "string",
- "Description": "string",
- "Steps": [
- {
- "Id": 0,
- "Name": "string",
- "Title": "string",
- "Description": "string",
- "Questions": [
- {
- "Id": 0,
- "Type": "string",
- "Layout": "string",
- "Formatter": "string",
- "MinimumNumberOfAnswers": 0,
- "MaximumNumberOfAnswers": 0,
- "RangeStep": 0,
- "MinimumRange": 0,
- "MaximumRange": 0,
- "ValidationRule": "string",
- "Text": "string",
- "Title": "string",
- "TextInputMask": "string",
- "TextLength": 0,
- "Image": "string",
- "Order": 0,
- "Answers": [
- {
- "Id": 0,
- "Key": "string",
- "Text": "string",
- "Description": "string",
- "Header": "string",
- "Image": "string",
- "Order": 0,
- "FollowupStep": { }
}
], - "Value": {
- "Ids": [
- 0
], - "Value": "string"
}
}
]
}
], - "Score": 0
}
]
}
{- "IsComplete": true,
- "IncompleteQuestionIds": [
- 0
]
}
Returns the contact's latest questionnaire which answers the conditions provided. If no questionnaire was found, a new questionnaire will be returned.
This API is deprecated. Use GET /v2.0/contacts/{contactId}/questionnaires/{submissionId} instead.
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The filter
Language required | string non-empty The returned language of the questionnaire's resources in case a new questionnaire is returned. |
ProductId | integer <int32> Nullable Returns a questionnaire associated with this product. If no product was specified, the latest submission which answers other conditions will be returned. |
IsComplete | boolean Returns the latest partial/completed questionnaire which answers other conditions. If submission status is not specified, the latest submission which answers other conditions will be returned. |
QuestionnaireTypeId | integer <int32> Nullable Returns a questionnaire associated with this questionnaire type. If no questionnaire type was specified, the latest submission which answers other conditions will be returned. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Language": "string",
- "ProductId": 0,
- "IsComplete": true,
- "QuestionnaireTypeId": 0
}
{- "Questionnaire": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "ContactTypeId": 0,
- "ContactTypeName": "string",
- "ProductId": 0,
- "QuestionnaireTypeId": 0,
- "Groups": [
- {
- "Id": 0,
- "Name": "string",
- "Key": "string",
- "Title": "string",
- "Description": "string",
- "Steps": [
- {
- "Id": 0,
- "Name": "string",
- "Title": "string",
- "Description": "string",
- "Questions": [
- {
- "Id": 0,
- "Type": "string",
- "Layout": "string",
- "Formatter": "string",
- "MinimumNumberOfAnswers": 0,
- "MaximumNumberOfAnswers": 0,
- "RangeStep": 0,
- "MinimumRange": 0,
- "MaximumRange": 0,
- "ValidationRule": "string",
- "Text": "string",
- "Title": "string",
- "TextInputMask": "string",
- "TextLength": 0,
- "Image": "string",
- "Order": 0,
- "Answers": [
- {
- "Id": 0,
- "Key": "string",
- "Text": "string",
- "Description": "string",
- "Header": "string",
- "Image": "string",
- "Order": 0,
- "FollowupStep": { }
}
], - "Value": {
- "Ids": [
- 0
], - "Value": "string"
}
}
]
}
], - "Score": 0
}
]
}, - "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string",
- "UId": "string"
}, - "Score": 0,
- "IsComplete": true,
- "CreatedDate": "2024-12-18T16:13:43Z",
- "ExpiryDate": "2024-12-18T16:13:43Z",
- "ProductId": 0
}
Calculate risk results for the latest submitted questionnaire and return calculation for the specified associated products. Note the following:
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request body
ProductIds | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ProductIds": [
- 0
]
}
{- "SubmissionId": 10,
- "CalculatedProductRiskCategories": [
- {
- "ProductId": 1,
- "ExpiryDate": "2024-12-20T14:35:37.1042396Z",
- "RiskCategory": {
- "Id": 3,
- "Name": "Balanced",
- "UId": "c38aa5a8-e064-4cd5-8026-4f6cc39cbddd"
}, - "ScoreRangePercentage": 23.8,
- "Groups": [
- {
- "Key": "Balanced",
- "Name": "Balanced",
- "RiskCategory": {
- "Id": 3,
- "Name": "Balanced",
- "UId": "c38aa5a8-e064-4cd5-8026-4f6cc39cbddd"
}, - "ScoreRangePercentage": 88.23
}
]
}
]
}
Attaches the calculated risk to the contact's profile. In order for this action to be successful, the contact needs to have a risk associated with his questionnaire; otherwise, a validation exception is returned.
This API is deprecated. Use POST /v2.0/contacts/{contactId}/questionnaires/calculated-risk/accept instead.
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Accepts calculated risk for one or more products from the specified questionnaire submission. If the questionnaire is a new one (and not the current active one), the current one will be considered expired, and the new questionnaire will become active. The expiry date of the questionnaire is defined according to the minimum expiry date of all products accepted.
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request body
SubmissionId | integer <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SubmissionId": 0,
- "ProductIds": [
- 0
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Stores the contact's chosen risk. A validation exception is thrown if the chosenRiskId is invalid.
contactId required | integer <int32> The id of the contact |
chosenRiskId required | integer <int32> The id of the risk category that will be set to the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Updates the constraints of a contact.
contactId required | integer <int32> The ID of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The optimization constraints of the contact
AssetClassConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.AssetClassConstraint) Nullable |
CurrencyConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.CurrencyConstraint) Nullable |
SecuritySectorConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.SecuritySectorConstraint) Nullable |
SecurityConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.SecurityConstraint) Nullable |
SecurityTypeConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.SecurityTypeConstraint) Nullable |
ContinentConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.ContinentConstraint) Nullable |
EconomicalZoneConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.EconomicalZoneConstraint) Nullable |
CountryConstraints | Array of objects (ContactManagement.Abstractions.UpdateContactOptimizationConstraints.CountryConstraint) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AssetClassConstraints": [
- {
- "AssetClassId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "SecurityId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "ContinentId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "CountryId": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
A person can retrieve an interaction, if they have access to it. A contact can retrieve an interaction if they are participating in it. A member can retrieve an interaction in the following cases: a) member has initiated the interaction or has hierarchy access to a member who initiated it, b) member has created the interaction or has hierarchy access to a member who created it, c) member is a participant in the interaction or has hierarchy access to at least a member who is participant in it, d) a contact (or contacts) that the member has access to is a participant to the interaction.
This API is deprecated. Use GET /v1.1/interactions/{id} instead.
id required | integer <int32> The id of the interaction |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "UId": "string",
- "DateFrom": "2024-12-18T16:13:43Z",
- "DateTo": "2024-12-18T16:13:43Z",
- "InitiatedBy": 0,
- "CreatedBy": 0,
- "OtherParticipants": "string",
- "InteractionTypeId": 0,
- "InteractionTopicId": 0,
- "MessageThreadId": 0,
- "FirstReminder": "string",
- "SecondReminder": "string",
- "IsCanceled": true,
- "IsEditable": true,
- "EmailDataIsInsufficient": true,
- "Participants": [
- {
- "PersonId": 0,
- "PersonUId": "string",
- "IsAccepted": true
}
]
}
A person can retrieve an interaction, if they have access to it. A contact can retrieve an interaction if they are participating in it. A member can retrieve an interaction in the following cases: a) member has initiated the interaction or has hierarchy access to a member who initiated it, b) member has created the interaction or has hierarchy access to a member who created it, c) member is a participant in the interaction or has hierarchy access to at least a member who is participant in it, d) a contact (or contacts) that the member has access to is a participant to the interaction.
id required | integer <int32> The id of the interaction |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "DateFrom": "2020-01-10T12:00:00",
- "DateTo": "2020-01-10T13:00:00",
- "InitiatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "CreatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "OtherParticipants": "James Deer, Albert Johnson",
- "InteractionTypeId": 15,
- "InteractionTopicId": 10,
- "MessageThreadId": 1500,
- "FirstReminder": "30 11 1 1 *",
- "SecondReminder": "45 11 1 1 *",
- "IsCanceled": false,
- "IsEditable": true,
- "EmailDataIsInsufficient": false,
- "Participants": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Manager Name",
- "IsAccepted": true,
- "PersonType": "Contact"
}, - {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Manager2 Name",
- "IsAccepted": false,
- "PersonType": "Member"
}
]
}
Edits an interaction. Contacts cannot edit interactions, while members can edit interactions if they are the creator or initiator, as well as if they have hierarchy access to a contact that is the creator/initiator of an interaction. Only a few parameters of an interaction can be edited; in the case the rest of the parameters need to be modified, the correct approach is to cancel the interaction and create a new one with the correct values.
id required | integer <int32> The id of the interaction to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
DateFrom | string <date-time> Nullable The starting date and time of the interaction (YYYY-MM-DD HH:MM). |
DateTo | string <date-time> Nullable The ending date and time of the interaction (YYYY-MM-DD HH:MM). |
FirstReminder | string Nullable The date and time for the first reminder for the interaction (YYYY-MM-DD HH:MM). |
SecondReminder | string Nullable The date and time for the second reminder for the interaction (YYYY-MM-DD HH:MM). |
IsCanceled | boolean Nullable Defines the status of the interaction (Valid/Canceled). |
SendEmail | boolean Send interaction calendar details to contact participants |
UpdateProperties | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DateFrom": "2020-01-10T12:00:00",
- "DateTo": "2020-01-10T13:00:00",
- "FirstReminder": "30 11 1 1 *",
- "SecondReminder": "45 11 1 1 *",
- "IsCanceled": false,
- "SendEmail": false,
- "UpdateProperties": [
- "DateFrom",
- "DateTo",
- "FirstReminder",
- "SecondReminder",
- "IsCanceled",
- "SendEmail"
]
}
{- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "DateFrom": "2020-01-10T12:00:00",
- "DateTo": "2020-01-10T13:00:00",
- "InitiatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "CreatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "OtherParticipants": "James Deer, Albert Johnson",
- "InteractionTypeId": 15,
- "InteractionTopicId": 10,
- "MessageThreadId": 1500,
- "FirstReminder": "30 11 1 1 *",
- "SecondReminder": "45 11 1 1 *",
- "IsCanceled": false,
- "IsEditable": true,
- "EmailDataIsInsufficient": false,
- "Participants": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Manager Name",
- "IsAccepted": true,
- "PersonType": "Contact"
}, - {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Manager2 Name",
- "IsAccepted": false,
- "PersonType": "Member"
}
]
}
Returns the journals of an interaction. A member who can see an interaction, can use this endpoint to retrieve the list of journals related to the interaction. Optionally, can pass the contactId to filter only the journals related to the contact. Contacts cannot use this endpoint.
This API is deprecated. Use GET /v1.1/interactions/{interactionId}/journals instead.
interactionId required | integer <int32> The id of the interaction |
contactId | integer <int32> The id of a contact. If passed, it filters journals that are created for the contact (CreatedForId) |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "InteractionId": 0,
- "InteractionUId": "string",
- "JournalId": 0,
- "JournalUId": "string",
- "Content": "string",
- "CreatorId": 0,
- "CreatorUId": "string",
- "CreateDate": "2024-12-18T16:13:43Z",
- "RelatedTo": "string",
- "CreatedForId": 0,
- "CreatedForUId": "string",
- "IsEditable": true
}
]
Returns the journals of an interaction. A member who can see an interaction, can use this endpoint to retrieve the list of journals related to the interaction. Optionally, can pass the contactId to filter only the journals related to the contact. Contacts cannot use this endpoint.
interactionId required | integer <int32> The id of the interaction |
contactId | integer <int32> The id of a contact. If passed, it filters journals that are created for the contact (CreatedForId) |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Interaction": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "Journal": {
- "Id": 200,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "Content": "The interaction was modified by member Relationship Manager on 05-18-20 11:00.",
- "Creator": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Manager Name",
- "PersonType": "Member"
}, - "CreatedFor": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Contact Name",
- "PersonType": "Contact"
}, - "CreateDate": "0001-01-01T00:00:00",
- "IsEditable": false
}, - {
- "Interaction": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "Journal": {
- "Id": 100,
- "UId": "00000000-0000-0000-0000-000000000000"
}, - "Content": "A new 'Call' entry was created for contact John Doe on 05-18-20 10:00.",
- "Creator": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Manager Name",
- "PersonType": "Member"
}, - "CreatedFor": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Contact Name",
- "PersonType": "Contact"
}, - "CreateDate": "0001-01-01T00:00:00",
- "IsEditable": false
}
]
Return member profiles of members which interacted with the specified contact
contactId required | integer <int32> Contact Id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InteractedMemberProfiles": [
- {
- "Id": 7,
- "FirstName": "Relationship",
- "LastName": "Manager 1",
- "Email": "RM1@additiv.com",
- "Phone": "41|528197785",
- "BankId": 1,
- "BranchId": 1,
- "HasProfilePicture": false
}, - {
- "Id": 8,
- "FirstName": "Relationship",
- "LastName": "Manager 2",
- "Email": "RM2@additiv.com",
- "Phone": "41|417841187",
- "BankId": 1,
- "BranchId": 1,
- "HasProfilePicture": true
}
]
}
Edits a journal. Only the creator of the journal can edit it.
contactId required | integer <int32> The contactId the journal was created for |
journalId required | integer <int32> The journalId to be edited |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the journal to edit
Content required | string non-empty |
RelatedTo | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Content": "string",
- "RelatedTo": "string"
}
{- "Id": 1,
- "UId": "36da7ba1-3d74-4e41-aebc-80acbc37dd1c",
- "Content": "Note for the contact",
- "CreatorId": 1,
- "CreateDate": "2024-12-18T14:35:37.1275659Z",
- "RelatedTo": "[1,2,3,4]",
- "CreatedForId": 5
}
A person (member or contact) who participates in an interaction can accept or reject his/her participation to it.
personId required | integer <int32> The person id who is participant of interaction |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the interaction to update
InteractionId | integer <int32> |
IsAccepted | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InteractionId": 0,
- "IsAccepted": true
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Search journals of a contact with filtering and sorting
contactId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
UId | string <uuid> Nullable |
CreatedByIds | Array of integers <int32> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
Content | string Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "UId": "1f99883c-61ed-49c4-805d-1329ceaa2e75",
- "CreatedByIds": [
- 1,
- 2,
- 3
], - "CreateDateFrom": "2000-06-20T00:00:00",
- "CreateDateTo": "2010-06-20T00:00:00",
- "Content": "Note",
- "SortBy": "Id",
- "SortOrder": "Ascending",
- "Page": 1,
- "PageSize": 10
}
{- "Results": [
- {
- "Id": 0,
- "UId": "string",
- "Content": "string",
- "Creator": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "PersonType": "Contact"
}, - "CreatedForId": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "IsEditable": true
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Creates a journal for a contact. The 'contactId' in the signature identifies the contact for whom the journal is created.
contactId required | integer <int32> The contact id for whom create a journal |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the journal to create
Content required | string non-empty |
RelatedTo | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Content": "string",
- "RelatedTo": "string"
}
{- "Id": 1,
- "UId": "afbe0d6f-59af-46c2-a92d-be03070f5c65",
- "Content": "Note for the contact",
- "CreatorId": 1,
- "CreateDate": "2024-12-18T14:35:37.1324325Z",
- "RelatedTo": "[1,2,3,4]",
- "CreatedForId": 5
}
Returns the journals of a member (journals of all contacts the member has direct access to) for a provided time range
memberId required | integer <int32> Member id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the request
FromDate required | string <date-time> The datetime from which to search |
ToDate required | string <date-time> The datetime to which to search |
TextLength | integer <int32> Nullable The length of the 'Content' text to be returned (0 means the whole 'Content' will be returned, positive integers truncate the 'Content' to the same size) |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "FromDate": "2024-12-18T16:13:43Z",
- "ToDate": "2024-12-18T16:13:43Z",
- "TextLength": 0,
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 1,
- "Content": "text",
- "Creator": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "John Doe",
- "PersonType": "Member"
}, - "CreatedFor": {
- "Id": 100,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "John Doe",
- "PersonType": "Member"
}, - "CreateDate": "2024-12-16T14:35:37.1350523Z",
- "IsEditable": false
}
], - "Page": 1,
- "PageSize": 10,
- "PageCount": 2,
- "TotalCount": 15
}
Creates an interaction related to 1 or more contacts. A member can create an interaction for one or more contacts that they have access to, while a contact can create an interaction only for himself/herself.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the interaction to create
DateFrom | string <date-time> The starting date and time of the interaction (YYYY-MM-DD HH:MM). |
DateTo | string <date-time> The ending date and time of the interaction (YYYY-MM-DD HH:MM). |
InitiatedById | integer <int32> The person who initiated the interaction (personId). |
Participants | Array of integers <int32> Nullable The list of participants for the interaction (list of person ids). A contact can only add themselves in the list (the advisor or the Helpdesk member will automatically be added as per the global settings). A member can add any contact(s) that they have access to plus any member(s) without restriction. |
OtherParticipants | string Nullable Other participants for the interaction - not in the system. |
InteractionTypeId | integer <int32> The type of the interaction (id). |
InteractionTopicId | integer <int32> The topic of the interaction (id). |
MessageThreadId | integer <int32> Nullable The id of the message thread related to the interaction. |
FirstReminder | string <date-time> Nullable The date and time for the first reminder for the interaction (YYYY-MM-DD HH:MM). |
SecondReminder | string <date-time> Nullable The date and time for the second reminder for the interaction (YYYY-MM-DD HH:MM). |
SendEmail | boolean Send interaction calendar details to contact participants |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DateFrom": "2020-01-10T12:00:00",
- "DateTo": "2020-01-10T13:00:00",
- "InitiatedById": 1,
- "Participants": [
- 1,
- 2,
- 3,
- 4
], - "OtherParticipants": "James Deer, Albert Johnson",
- "InteractionTypeId": 10,
- "InteractionTopicId": 12,
- "MessageThreadId": 1500,
- "FirstReminder": "2020-01-10T11:30:00",
- "SecondReminder": "2020-01-10T11:45:00",
- "SendEmail": false
}
{- "Id": 1,
- "DateFrom": "2020-01-10T12:00:00",
- "DateTo": "2020-01-10T13:00:00",
- "InitiatedBy": 1,
- "CreatedBy": 1,
- "OtherParticipants": "James Deer, Albert Johnson",
- "InteractionTypeId": 15,
- "InteractionTopicId": 10,
- "MessageThreadId": 1500,
- "FirstReminder": "30 11 1 1 *",
- "SecondReminder": "45 11 1 1 *",
- "IsCanceled": false,
- "EmailDataIsInsufficient": false
}
Returns a list of a contact's interactions based on the criteria entered. A contact can retrieve interactions only if they are participants. A member can retrieve interactions if they have hierarchy access to the contactId. Depending on business rule defined in the Global Settings, the details of some interactions will be hidden. No journals are returned.
This API is deprecated. Use POST /v1.1/contacts/{contactId}/interactions instead.
contactId required | integer <int32> The contactId the interaction was created for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search filter with parameters
DateFrom | string <date-time> Nullable The starting date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
DateTo | string <date-time> Nullable The ending date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
IncludePartialDateMatch | boolean Set to true if specifying a date range and want to include interactions which are not fully within the date range. |
InitiatedById | integer <int32> Nullable The person who initiated an interaction (personId) |
CreatedBy | integer <int32> Nullable The person who created an interaction (personId) |
Participants | Array of integers <int32> Nullable The list of participants of an interaction (list of person ids) |
InteractionTypeId | integer <int32> Nullable The type of an interaction (id) |
InteractionTopicId | integer <int32> Nullable The topic of an interaction (id) |
IsCanceled | boolean Nullable The parameter that defines is an interaction is active or canceled |
SortColumn | string Nullable The result sorted by column |
SortDescending | boolean Nullable The result sorted descending |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "IncludePartialDateMatch": false,
- "InitiatedById": 1,
- "CreatedBy": 5,
- "Participants": [
- 10,
- 12
], - "InteractionTypeId": 10,
- "InteractionTopicId": 12,
- "IsCanceled": false,
- "SortColumn": "Id",
- "SortDescending": true,
- "PageNumber": 1,
- "PageSize": 1000
}
{- "Interactions": [
- {
- "Id": 0,
- "DateFrom": "2024-12-18T16:13:43Z",
- "DateTo": "2024-12-18T16:13:43Z",
- "InitiatedBy": 0,
- "CreatedBy": 0,
- "Participants": [
- 0
], - "OtherParticipants": "string",
- "InteractionTypeId": 0,
- "InteractionTopicId": 0,
- "FirstReminder": "string",
- "SecondReminder": "string",
- "IsCanceled": true,
- "IsRestrictedAccess": true
}
], - "TotalNumberOfResults": 0
}
Returns a list of a contact's interactions based on the criteria entered. A contact can retrieve interactions only if they are participants. A member can retrieve interactions if they have hierarchy access to the contactId. Depending on business rule defined in the Global Settings, the details of some interactions will be hidden. No journals are returned.
contactId required | integer <int32> The contactId the interaction was created for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search filter with parameters
DateFrom | string <date-time> Nullable The starting date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
DateTo | string <date-time> Nullable The ending date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
IncludePartialDateMatch | boolean Set to true if specifying a date range and want to include interactions which are not fully within the date range. |
InitiatedById | integer <int32> Nullable The person who initiated an interaction (personId) |
CreatedBy | integer <int32> Nullable The person who created an interaction (personId) |
Participants | Array of integers <int32> Nullable The list of participants of an interaction (list of person ids) |
InteractionTypeId | integer <int32> Nullable The type of an interaction (id) |
InteractionTopicId | integer <int32> Nullable The topic of an interaction (id) |
IsCanceled | boolean Nullable The parameter that defines is an interaction is active or canceled |
SortColumn | string Nullable The result sorted by column |
SortDescending | boolean Nullable The result sorted descending |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "IncludePartialDateMatch": false,
- "InitiatedById": 1,
- "CreatedBy": 5,
- "Participants": [
- 10,
- 12
], - "InteractionTypeId": 10,
- "InteractionTopicId": 12,
- "IsCanceled": false,
- "SortColumn": "Id",
- "SortDescending": true,
- "PageNumber": 1,
- "PageSize": 1000
}
{- "Interactions": [
- {
- "Id": 1,
- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "InitiatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "CreatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "Participants": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - {
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}
], - "OtherParticipants": "Joe Doe",
- "InteractionTypeId": 1,
- "InteractionTopicId": 1,
- "FirstReminder": "* * * * 1",
- "SecondReminder": "* * * * 2",
- "IsCanceled": false,
- "IsRestrictedAccess": false
}, - {
- "Id": 2,
- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "InitiatedBy": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - "CreatedBy": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - "Participants": [
- {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - {
- "Id": 4,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}
], - "OtherParticipants": "Jane Doe",
- "InteractionTypeId": 2,
- "InteractionTopicId": 2,
- "FirstReminder": "* * * * 1",
- "SecondReminder": "* * * * 2",
- "IsCanceled": false,
- "IsRestrictedAccess": false
}, - {
- "Id": 3,
- "IsRestrictedAccess": true
}
], - "TotalNumberOfResults": 3
}
Connects one or more (existing) journals to an interaction. Members that have access to see an interaction are allowed to connect journals to the interaction. For example, a member can create a journal for a contact (using POST /v1.0/contacts/{contactId}/journal) and then call this endpoint to connect the journal to the interaction.
interactionId required | integer <int32> The id of the interaction |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Ids of the journals to connect to the interaction
JournalIds | Array of integers <int32> Nullable The id/ids of the journals to connect to the interaction. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "JournalIds": [
- 1,
- 2
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Removes the connection of an existing journal to an interaction. Members that have access to edit an interaction are allowed to remove the connection to the interaction. Contacts do not have the ability for such action.
interactionId required | integer <int32> The id of the interaction |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Id of a journal to remove from an interaction
JournalId | integer <int32> The id of the journal to remove from the interaction. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "JournalId": 1
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Returns a list of a member's interactions based on the criteria entered. Members can retrieve interactions if they have initiated or created them, as well as when they are participants. No journals are returned.
When the DateFrom parameter is not passed, the default behavior of the endpoint is to return interactions that take place between today() and the future.
When the IsCanceled parameter is not passed, the default behavior of the endpoint is to return only the 'active' interactions. This API is deprecated. Use POST /v1.3/members/{memberId}/interactions instead.
memberId required | integer <int32> The memberId the interaction is creator or initiator or participant |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search filter with parameters
DateFrom | string <date-time> Nullable The starting date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
DateTo | string <date-time> Nullable The ending date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
IncludePartialDateMatch | boolean Set to true if specifying a date range and want to include interactions which are not fully within the date range. |
InitiatedById | integer <int32> Nullable The person who initiated an interaction (personId) |
CreatedBy | integer <int32> Nullable The person who created an interaction (personId) |
Participants | Array of integers <int32> Nullable The list of participants of an interaction (list of person ids) |
InteractionTypeId | integer <int32> Nullable The type of an interaction (id) |
InteractionTopicId | integer <int32> Nullable The topic of an interaction (id) |
IsCanceled | boolean Nullable The parameter that defines is an interaction is active or canceled |
SortColumn | string Nullable The result sorted by column |
SortDescending | boolean Nullable The result sorted descending |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "IncludePartialDateMatch": false,
- "InitiatedById": 1,
- "CreatedBy": 5,
- "Participants": [
- 10,
- 12
], - "InteractionTypeId": 10,
- "InteractionTopicId": 12,
- "IsCanceled": false,
- "SortColumn": "Id",
- "SortDescending": true,
- "PageNumber": 1,
- "PageSize": 1000
}
{- "Interactions": [
- {
- "Id": 0,
- "DateFrom": "2024-12-18T16:13:43Z",
- "DateTo": "2024-12-18T16:13:43Z",
- "InitiatedBy": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "IsMember": true
}, - "CreatedBy": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "PersonType": "Contact"
}, - "Participants": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "IsMember": true
}
], - "OtherParticipants": "string",
- "InteractionTypeId": 0,
- "InteractionTopicId": 0,
- "FirstReminder": "string",
- "SecondReminder": "string",
- "IsCanceled": true
}
], - "TotalNumberOfResults": 0
}
Returns a list of a member's interactions based on the criteria entered. Members can retrieve interactions if they have initiated or created them, as well as when they are participants. No journals are returned.
When the DateFrom parameter is not passed, the default behavior of the endpoint is to return interactions that take place between today() and the future.
When the IsCanceled parameter is not passed, the default behavior of the endpoint is to return only the 'active' interactions.
memberId required | integer <int32> The memberId the interaction is creator or initiator or participant |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search filter with parameters
DateFrom | string <date-time> Nullable The starting date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
DateTo | string <date-time> Nullable The ending date and time of an interaction (YYYY-MM-DD HH:MM). When the time is not defined, the endpoint assumes 00:00 by default. |
IncludePartialDateMatch | boolean Set to true if specifying a date range and want to include interactions which are not fully within the date range. |
InitiatedById | integer <int32> Nullable The person who initiated an interaction (personId) |
CreatedBy | integer <int32> Nullable The person who created an interaction (personId) |
Participants | Array of integers <int32> Nullable The list of participants of an interaction (list of person ids) |
InteractionTypeId | integer <int32> Nullable The type of an interaction (id) |
InteractionTopicId | integer <int32> Nullable The topic of an interaction (id) |
IsCanceled | boolean Nullable The parameter that defines is an interaction is active or canceled |
SortColumn | string Nullable The result sorted by column |
SortDescending | boolean Nullable The result sorted descending |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "IncludePartialDateMatch": false,
- "InitiatedById": 1,
- "CreatedBy": 5,
- "Participants": [
- 10,
- 12
], - "InteractionTypeId": 10,
- "InteractionTopicId": 12,
- "IsCanceled": false,
- "SortColumn": "Id",
- "SortDescending": true,
- "PageNumber": 1,
- "PageSize": 1000
}
{- "Interactions": [
- {
- "Id": 1,
- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "InitiatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - "CreatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - "Participants": [
- {
- "Id": 100,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - {
- "Id": 200,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}
], - "OtherParticipants": "Joe Doe",
- "InteractionTypeId": 1,
- "InteractionTopicId": 1,
- "FirstReminder": "* * * * 1",
- "SecondReminder": "* * * * 2",
- "IsCanceled": false
}, - {
- "Id": 2,
- "DateFrom": "2020-11-25T11:00:00",
- "DateTo": "2020-11-25T12:00:00",
- "InitiatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - "CreatedBy": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}, - "Participants": [
- {
- "Id": 100,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Contact"
}, - {
- "Id": 200,
- "UId": "00000000-0000-0000-0000-000000000000",
- "PersonType": "Member"
}
], - "OtherParticipants": "Jane Doe",
- "InteractionTypeId": 1,
- "InteractionTopicId": 1,
- "FirstReminder": "* * * * 1",
- "SecondReminder": "* * * * 2",
- "IsCanceled": false
}
], - "TotalNumberOfResults": 2
}
Deletes a currency.
currencyId required | integer <int32> The id of the currency. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ResultTypes": [
- "CurrencyHasFx"
], - "DeletedSuccessfully": true
}
Gets the details of a currency.
currencyId required | integer <int32> The id of the currency. |
language | string The language of the localized resource |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
Updates a currency
currencyId required | integer <int32> The id of the currency. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Name | string Nullable |
CurrencyCode | string Nullable |
Symbol | string Nullable |
RiskFreeRate | number <double> Nullable |
SubCurrencyName | string Nullable |
SubCurrencyFactor | number <double> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
{- "ResultTypes": [
- "NameExists"
], - "UpdatedSuccessfully": true
}
Retrieves the latest currency exchange rates for the currency pairs specified in the parameters. Automatically tries to convert exchange rates that are not available for the requested currency pairs by using indirect quotes (if available).
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
CurrencyExchangeRateRequests required | Array of objects (CurrencyExchangeRateRequest) |
PriceDate | string <date-time> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyExchangeRateRequests": [
- {
- "BaseCurrencyCode": "CHF",
- "QuoteCurrencyCode": "EUR"
}, - {
- "BaseCurrencyCode": "EUR",
- "QuoteCurrencyCode": "CHF"
}, - {
- "BaseCurrencyCode": "CHF",
- "QuoteCurrencyCode": "USD"
}
]
}
{- "CurrencyExchangeRates": [
- {
- "BaseCurrencyCode": "CHF",
- "QuoteCurrencyCode": "EUR",
- "ExchangeRate": 0.8729,
- "ValuationDate": "2024-12-17T14:35:37.1564201Z",
- "ValidityDate": "2024-12-18T15:35:37.1564203Z"
}, - {
- "BaseCurrencyCode": "EUR",
- "QuoteCurrencyCode": "CHF",
- "ExchangeRate": 1.14555,
- "ValuationDate": "2024-12-17T14:35:37.1564201Z",
- "ValidityDate": "2024-12-18T15:35:37.1564203Z"
}, - {
- "BaseCurrencyCode": "CHF",
- "QuoteCurrencyCode": "USD",
- "ExchangeRate": 0.9975,
- "ValuationDate": "2024-12-17T14:35:37.1564201Z",
- "ValidityDate": "2024-12-18T15:35:37.1564203Z"
}
]
}
Loads and saves all the available currencies fx rates from a price feed provider given a list of currency pairs. FX Rates history queried for a currency pair varies depending on the currency pair latest valuation date.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Contains the list of currency pairs to import FX rates history for. If an empty currency pair list is passed then this will trigger the import of fx rates history for all currency pairs from the database which have an IntegrationIdentifier and an IntegrationIdentifierType.
CurrenciesPairs | Array of objects (CurrencyPair) Nullable The list of currencies pairs to import FX rates history for |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrenciesPairs": [
- {
- "BaseIsoCode": "CHF",
- "QuoteIsoCode": "EUR"
}, - {
- "BaseIsoCode": "USD",
- "QuoteIsoCode": "GBP"
}
]
}
{- "LongRunningRequestId": "string"
}
For each currency pair return the latest rate and the rate latest date and calculate the 1Day and YTD performance of the currency cross-rate
Accept-Language | string The ISO 639-1 language to use for localizable data. |
CurrencyExchangeRateRequests required | Array of objects (CurrencyExchangeRateRequest) |
PriceDate | string <date-time> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyExchangeRateRequests": [
- {
- "BaseCurrencyCode": "CHF",
- "QuoteCurrencyCode": "EUR"
}, - {
- "BaseCurrencyCode": "EUR",
- "QuoteCurrencyCode": "CHF"
}, - {
- "BaseCurrencyCode": "CHF",
- "QuoteCurrencyCode": "USD"
}
]
}
{- "CurrencyExchangeRatesPerformance": [
- {
- "BaseCurrencyCode": "string",
- "BaseCurrencyId": 0,
- "QuoteCurrencyCode": "string",
- "QuoteCurrencyId": 0,
- "Price": 0,
- "PriceDate": "2024-12-18T16:13:43Z",
- "Kpis": {
- "OneDay": 0,
- "Ytd": 0
}
}
]
}
Saves the latest fx rates provided by the User. Note that these are not saved in the fx rates history.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Contains a list of currency pairs, each pair with the newest rate.
BaseIsoCode | string Nullable The ISO code of the base currency |
QuoteIsoCode | string Nullable The ISO code of the quote currency |
Rate | number <double> The rate of the fx pair |
Date | string <date-time> The datetime of the rate of the fx pair |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "BaseIsoCode": "CHF",
- "QuoteIsoCode": "EUR",
- "Rate": 0.9325,
- "Date": "2024-12-18T00:00:00+00:00"
}, - {
- "BaseIsoCode": "USD",
- "QuoteIsoCode": "EUR",
- "Rate": 0.8532,
- "Date": "2024-12-18T00:00:00+00:00"
}
]
{- "Message": "string"
}
Returns the historical prices of the passed currency cross-pair.
The user optionally can pass a date range of interest for which to obtain these.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO.
BaseCurrencyCode required | string non-empty The ISO code of the currency pair base currency |
QuoteCurrencyCode required | string non-empty The ISO code of the currency pair quote currency |
FromDate | string <date-time> Nullable |
ToDate | string <date-time> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "BaseCurrencyCode": "EUR",
- "QuoteCurrencyCode": "USD",
- "FromDate": "2022-12-18T14:35:37.2029905Z",
- "ToDate": "2024-11-18T14:35:37.2029915Z"
}
{- "HistoricalData": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Price": 0,
- "Open": 0,
- "High": 0,
- "Low": 0
}
]
}
Creates new currency
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Name | string Nullable |
CurrencyCode | string Nullable |
Symbol | string Nullable |
RiskFreeRate | number <double> Nullable |
SubCurrencyName | string Nullable |
SubCurrencyFactor | number <double> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
{- "ResultTypes": [
- "NameExists"
], - "CreatedSuccessfully": true,
- "Id": 0,
- "UId": "string"
}
Searches currencies
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search parameters.
Ids | Array of integers <int32> Nullable |
Name | string Nullable |
ThreeLetterIsoCode | string Nullable |
Symbol | string Nullable |
RiskFreeRateFrom | number <double> Nullable |
RiskFreeRateTo | number <double> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 1,
- 2
], - "Name": "Swiss",
- "ThreeLetterIsoCode": "CH",
- "Symbol": "€",
- "RiskFreeRateFrom": 10,
- "RiskFreeRateTo": 20,
- "SortBy": "Id",
- "SortOrder": "Ascending",
- "Page": 1,
- "PageSize": 10
}
{- "Results": [
- {
- "Id": 1,
- "UId": "a5b5b5ae-7be1-4676-975a-4c041b265314",
- "Name": "Swiss Franc",
- "CurrencyCode": "EUR",
- "Symbol": "Fr",
- "RiskFreeRate": 100,
- "SubCurrencyName": "Swiss",
- "SubCurrencyFactor": 11.2
}, - {
- "Id": 2,
- "UId": "eee2a85d-29cc-4d24-b943-6286f5bd53ac",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€",
- "RiskFreeRate": 23.4,
- "SubCurrencyName": "Germany",
- "SubCurrencyFactor": 11.2
}
], - "Page": 1,
- "PageSize": 10,
- "PageCount": 10,
- "TotalCount": 100
}
Preview API
Additiv publishes preview features as APIs for feedback and early adopters.Preview APIs may change or discontinue at any time without notice.
We also may choose not to release a Preview into GA.
Retrieves the latest flat member data for a member id in the application currency.
memberId required | integer <int32> The id of the member |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReferenceId": 4,
- "CreateDate": "2019-11-29T00:00:00",
- "Data": "{\"ContactId\":4,\"Date\":\"2019-09-19T00:00:00\",\"Portfolios\":[{\"Id\":1,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":483032.800000000000,\"Cash\":352319.300000000000,\"Investment\":130713.500000000000},\"KPI\":{\"Risk\":0.187089534319,\"InceptionPerf\":0.000501779870,\"DailyPerf\":0.000001358000,\"SharpeRatio\":0.002682030676,\"DailyPerfAmount\":3.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.1711283995,\"Quantity\":5167.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.2402913632,\"Quantity\":1026.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.3179702496,\"Quantity\":10265.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0118283892,\"Quantity\":1.000000,\"AccountId\":147}},{\"Instrument\":{\"Id\":112,\"Weight\":0.2587815982,\"Quantity\":1.000000,\"AccountId\":27}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.3179702496}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.4232481519}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.2587815982}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.7597086365}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.2402913632}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.8288716002}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.1711283995}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.3179702496}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.4114197627}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.2706099874}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.2706099874}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.1711283995}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.2402913632}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.3179702496}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.7293900123}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.2706099874}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":9,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":1230354.679000000000,\"Cash\":792002.149000000000,\"Investment\":438352.530000000000},\"KPI\":{\"Risk\":0.101329210276,\"InceptionPerf\":0.014927129359,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.147313191510,\"DailyPerfAmount\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.0588822079,\"Quantity\":407.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0653987800,\"Quantity\":4537.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":33,\"Isin\":\"ES0178430E18\",\"Weight\":0.0586347215,\"Quantity\":11244.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0601777692,\"Quantity\":6000.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":55,\"Isin\":\"LU0048579410\",\"Weight\":0.0261802556,\"Quantity\":13500.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":56,\"Isin\":\"LU0048580004\",\"Weight\":0.0105686597,\"Quantity\":24.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":57,\"Isin\":\"LU0048581077\",\"Weight\":0.1225807099,\"Quantity\":515.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":58,\"Isin\":\"LU0048584766\",\"Weight\":0.0770184416,\"Quantity\":800.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0690991804,\"Quantity\":1930.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0566909698,\"Quantity\":1125.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":103,\"Isin\":\"US5949181045\",\"Weight\":0.0384868695,\"Quantity\":3250.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":110,\"Weight\":0.0580259507,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0928866463,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":112,\"Weight\":0.0980917145,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":113,\"Weight\":0.0455195570,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":114,\"Weight\":0.0617575657,\"Quantity\":1.000000,\"AccountId\":3}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.1169081586}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.5806014125}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.1952133055}},{\"Currency\":{\"Id\":4,\"Code\":\"GBP\",\"Weight\":0.0455195570}},{\"Currency\":{\"Id\":5,\"Code\":\"JPY\",\"Weight\":0.0617575657}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9433090295}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0566909698}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9346012193}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0653987800}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.0588822079}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.2793891100}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.3054472472}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.3562814342}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.3562814342}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0601777692}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0653987800}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.3054472472}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0566909698}},{\"Country\":{\"Id\":66,\"Name\":\"Spain\",\"Weight\":0.0586347215}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.0588822079}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.0384868695}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.3382713179}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.3054472472}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.3562814342}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.2500000000}},{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":33,\"Isin\":\"ES0178430E18\",\"Weight\":0.1500000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":103,\"Isin\":\"US5949181045\",\"Weight\":0.3000000000}},{\"Instrument\":{\"Id\":110,\"Weight\":0.1500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.4000000000}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.1500000000}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.4500000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9500000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0500000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9500000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0500000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.2500000000}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.6000000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.1500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.1500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":66,\"Name\":\"Spain\",\"Weight\":0.1500000000}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.2500000000}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.3000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.8500000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.1500000000}}],\"OptimisationConstraints\":[{\"Id\":1614}]}}},{\"Id\":10,\"Values\":{\"Information\":{\"ProductId\":1},\"MarketValue\":{\"Total\":61472.220000000000,\"Cash\":61282.350000000000,\"Investment\":189.870000000000},\"KPI\":{\"Risk\":0.000266320272,\"InceptionPerf\":0.017230583371,\"DailyPerf\":0.000000000000,\"SharpeRatio\":64.698729988052,\"DailyPerfAmount\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":45,\"Isin\":\"FR0010344960\",\"Weight\":0.7248802792,\"Quantity\":1000.000000,\"AccountId\":51}},{\"Instrument\":{\"Id\":102,\"Isin\":\"US4642888519\",\"Weight\":0.2720310084,\"Quantity\":280.000000,\"AccountId\":51}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0005890465,\"Quantity\":1.000000,\"AccountId\":23}},{\"Instrument\":{\"Id\":112,\"Weight\":0.0024996657,\"Quantity\":1.000000,\"AccountId\":28}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.7254693257}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.2745306741}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9999999998}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9999999998}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9969112876}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0030887122}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0030887122}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.7248802792}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.2720310084}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9969112876}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0030887122}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":25,\"Values\":{\"Information\":{\"ProductId\":1},\"MarketValue\":{\"Total\":-42.890000000000,\"Cash\":-42.890000000000,\"Investment\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0000000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0000000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.0000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.0000000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.0000000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0000000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0000000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.0000000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0000000000}}]}},{\"Id\":26,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":28,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":29,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":31,\"Values\":{\"Information\":{\"ProductId\":1},\"KPI\":{\"Risk\":0.164024004413,\"InceptionPerf\":0.000000000000,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.000000000000}}},{\"Id\":39,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":40,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":41,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":48,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":49,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":50,\"Values\":{\"Information\":{\"ProductId\":2}}},{\"Id\":51,\"Values\":{\"Information\":{\"ProductId\":2}}},{\"Id\":52,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":55,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":56,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":57,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":60,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":61,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":10502.110000000000,\"Cash\":0.000000000000,\"Investment\":10502.110000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":111,\"Weight\":1.0000000000,\"Quantity\":1.000000,\"AccountId\":209}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":1.0000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":1.0000000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":1.0000000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":1.0000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":1.0000000000}}]}},{\"Id\":63,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":65,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":367344.370000000000,\"Cash\":356842.260000000000,\"Investment\":10502.110000000000},\"KPI\":{\"Risk\":0.287288189949,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.000000000000,\"DailyPerfAmount\":-2905.510000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0755674845,\"Quantity\":3799.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0079883625,\"Quantity\":2.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0032163008,\"Quantity\":3799.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8846385749,\"Quantity\":1990.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0285892771,\"Quantity\":1.000000,\"AccountId\":220}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.9999999998}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.1153614249}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8846385749}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9244325153}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0755674845}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9681944219}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0032163008}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0285892771}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0285892771}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0079883625}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0755674845}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0032163008}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8846385749}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9681944219}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0032163008}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0285892771}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":67,\"Values\":{\"Information\":{\"ProductId\":1}}}]}"
}
Preview API
Additiv publishes preview features as APIs for feedback and early adopters.Preview APIs may change or discontinue at any time without notice.
We also may choose not to release a Preview into GA.
Retrieves the latest flat personal data for a contact id
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReferenceId": 4,
- "CreateDate": "2019-11-29T00:00:00",
- "Data": "{\"ContactId\":4,\"Date\":\"2019-09-19T00:00:00\",\"Portfolios\":[{\"Id\":1,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":483032.800000000000,\"Cash\":352319.300000000000,\"Investment\":130713.500000000000},\"KPI\":{\"Risk\":0.187089534319,\"InceptionPerf\":0.000501779870,\"DailyPerf\":0.000001358000,\"SharpeRatio\":0.002682030676,\"DailyPerfAmount\":3.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.1711283995,\"Quantity\":5167.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.2402913632,\"Quantity\":1026.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.3179702496,\"Quantity\":10265.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0118283892,\"Quantity\":1.000000,\"AccountId\":147}},{\"Instrument\":{\"Id\":112,\"Weight\":0.2587815982,\"Quantity\":1.000000,\"AccountId\":27}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.3179702496}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.4232481519}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.2587815982}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.7597086365}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.2402913632}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.8288716002}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.1711283995}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.3179702496}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.4114197627}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.2706099874}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.2706099874}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.1711283995}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.2402913632}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.3179702496}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.7293900123}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.2706099874}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":9,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":1230354.679000000000,\"Cash\":792002.149000000000,\"Investment\":438352.530000000000},\"KPI\":{\"Risk\":0.101329210276,\"InceptionPerf\":0.014927129359,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.147313191510,\"DailyPerfAmount\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.0588822079,\"Quantity\":407.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0653987800,\"Quantity\":4537.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":33,\"Isin\":\"ES0178430E18\",\"Weight\":0.0586347215,\"Quantity\":11244.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0601777692,\"Quantity\":6000.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":55,\"Isin\":\"LU0048579410\",\"Weight\":0.0261802556,\"Quantity\":13500.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":56,\"Isin\":\"LU0048580004\",\"Weight\":0.0105686597,\"Quantity\":24.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":57,\"Isin\":\"LU0048581077\",\"Weight\":0.1225807099,\"Quantity\":515.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":58,\"Isin\":\"LU0048584766\",\"Weight\":0.0770184416,\"Quantity\":800.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0690991804,\"Quantity\":1930.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0566909698,\"Quantity\":1125.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":103,\"Isin\":\"US5949181045\",\"Weight\":0.0384868695,\"Quantity\":3250.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":110,\"Weight\":0.0580259507,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0928866463,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":112,\"Weight\":0.0980917145,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":113,\"Weight\":0.0455195570,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":114,\"Weight\":0.0617575657,\"Quantity\":1.000000,\"AccountId\":3}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.1169081586}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.5806014125}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.1952133055}},{\"Currency\":{\"Id\":4,\"Code\":\"GBP\",\"Weight\":0.0455195570}},{\"Currency\":{\"Id\":5,\"Code\":\"JPY\",\"Weight\":0.0617575657}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9433090295}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0566909698}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9346012193}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0653987800}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.0588822079}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.2793891100}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.3054472472}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.3562814342}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.3562814342}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0601777692}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0653987800}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.3054472472}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0566909698}},{\"Country\":{\"Id\":66,\"Name\":\"Spain\",\"Weight\":0.0586347215}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.0588822079}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.0384868695}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.3382713179}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.3054472472}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.3562814342}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.2500000000}},{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":33,\"Isin\":\"ES0178430E18\",\"Weight\":0.1500000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":103,\"Isin\":\"US5949181045\",\"Weight\":0.3000000000}},{\"Instrument\":{\"Id\":110,\"Weight\":0.1500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.4000000000}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.1500000000}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.4500000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9500000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0500000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9500000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0500000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.2500000000}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.6000000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.1500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.1500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":66,\"Name\":\"Spain\",\"Weight\":0.1500000000}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.2500000000}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.3000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.8500000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.1500000000}}],\"OptimisationConstraints\":[{\"Id\":1614}]}}},{\"Id\":10,\"Values\":{\"Information\":{\"ProductId\":1},\"MarketValue\":{\"Total\":61472.220000000000,\"Cash\":61282.350000000000,\"Investment\":189.870000000000},\"KPI\":{\"Risk\":0.000266320272,\"InceptionPerf\":0.017230583371,\"DailyPerf\":0.000000000000,\"SharpeRatio\":64.698729988052,\"DailyPerfAmount\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":45,\"Isin\":\"FR0010344960\",\"Weight\":0.7248802792,\"Quantity\":1000.000000,\"AccountId\":51}},{\"Instrument\":{\"Id\":102,\"Isin\":\"US4642888519\",\"Weight\":0.2720310084,\"Quantity\":280.000000,\"AccountId\":51}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0005890465,\"Quantity\":1.000000,\"AccountId\":23}},{\"Instrument\":{\"Id\":112,\"Weight\":0.0024996657,\"Quantity\":1.000000,\"AccountId\":28}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.7254693257}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.2745306741}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9999999998}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9999999998}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9969112876}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0030887122}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0030887122}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.7248802792}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.2720310084}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9969112876}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0030887122}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":25,\"Values\":{\"Information\":{\"ProductId\":1},\"MarketValue\":{\"Total\":-42.890000000000,\"Cash\":-42.890000000000,\"Investment\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0000000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0000000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.0000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.0000000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.0000000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0000000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0000000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.0000000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0000000000}}]}},{\"Id\":26,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":28,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":29,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":31,\"Values\":{\"Information\":{\"ProductId\":1},\"KPI\":{\"Risk\":0.164024004413,\"InceptionPerf\":0.000000000000,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.000000000000}}},{\"Id\":39,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":40,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":41,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":48,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":49,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":50,\"Values\":{\"Information\":{\"ProductId\":2}}},{\"Id\":51,\"Values\":{\"Information\":{\"ProductId\":2}}},{\"Id\":52,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":55,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":56,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":57,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":60,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":61,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":10502.110000000000,\"Cash\":0.000000000000,\"Investment\":10502.110000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":111,\"Weight\":1.0000000000,\"Quantity\":1.000000,\"AccountId\":209}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":1.0000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":1.0000000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":1.0000000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":1.0000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":1.0000000000}}]}},{\"Id\":63,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":65,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":367344.370000000000,\"Cash\":356842.260000000000,\"Investment\":10502.110000000000},\"KPI\":{\"Risk\":0.287288189949,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.000000000000,\"DailyPerfAmount\":-2905.510000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0755674845,\"Quantity\":3799.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0079883625,\"Quantity\":2.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0032163008,\"Quantity\":3799.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8846385749,\"Quantity\":1990.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0285892771,\"Quantity\":1.000000,\"AccountId\":220}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.9999999998}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.1153614249}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8846385749}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9244325153}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0755674845}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9681944219}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0032163008}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0285892771}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0285892771}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0079883625}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0755674845}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0032163008}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8846385749}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9681944219}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0032163008}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0285892771}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":67,\"Values\":{\"Information\":{\"ProductId\":1}}}]}"
}
Preview API
Additiv publishes preview features as APIs for feedback and early adopters.Preview APIs may change or discontinue at any time without notice.
We also may choose not to release a Preview into GA.
Retrieves the latest flat portfolio data for a contact id in the application currency.
contactId required | integer <int32> The id of the contact |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReferenceId": 4,
- "CreateDate": "2019-11-29T00:00:00",
- "Data": "{\"ContactId\":4,\"Date\":\"2019-09-19T00:00:00\",\"Portfolios\":[{\"Id\":1,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":483032.800000000000,\"Cash\":352319.300000000000,\"Investment\":130713.500000000000},\"KPI\":{\"Risk\":0.187089534319,\"InceptionPerf\":0.000501779870,\"DailyPerf\":0.000001358000,\"SharpeRatio\":0.002682030676,\"DailyPerfAmount\":3.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.1711283995,\"Quantity\":5167.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.2402913632,\"Quantity\":1026.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.3179702496,\"Quantity\":10265.000000,\"AccountId\":34}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0118283892,\"Quantity\":1.000000,\"AccountId\":147}},{\"Instrument\":{\"Id\":112,\"Weight\":0.2587815982,\"Quantity\":1.000000,\"AccountId\":27}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.3179702496}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.4232481519}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.2587815982}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.7597086365}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.2402913632}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.8288716002}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.1711283995}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.3179702496}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.4114197627}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.2706099874}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.2706099874}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.1711283995}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.2402913632}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.3179702496}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.7293900123}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.2706099874}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":9,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":1230354.679000000000,\"Cash\":792002.149000000000,\"Investment\":438352.530000000000},\"KPI\":{\"Risk\":0.101329210276,\"InceptionPerf\":0.014927129359,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.147313191510,\"DailyPerfAmount\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.0588822079,\"Quantity\":407.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0653987800,\"Quantity\":4537.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":33,\"Isin\":\"ES0178430E18\",\"Weight\":0.0586347215,\"Quantity\":11244.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0601777692,\"Quantity\":6000.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":55,\"Isin\":\"LU0048579410\",\"Weight\":0.0261802556,\"Quantity\":13500.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":56,\"Isin\":\"LU0048580004\",\"Weight\":0.0105686597,\"Quantity\":24.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":57,\"Isin\":\"LU0048581077\",\"Weight\":0.1225807099,\"Quantity\":515.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":58,\"Isin\":\"LU0048584766\",\"Weight\":0.0770184416,\"Quantity\":800.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0690991804,\"Quantity\":1930.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0566909698,\"Quantity\":1125.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":103,\"Isin\":\"US5949181045\",\"Weight\":0.0384868695,\"Quantity\":3250.000000,\"AccountId\":41}},{\"Instrument\":{\"Id\":110,\"Weight\":0.0580259507,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0928866463,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":112,\"Weight\":0.0980917145,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":113,\"Weight\":0.0455195570,\"Quantity\":1.000000,\"AccountId\":3}},{\"Instrument\":{\"Id\":114,\"Weight\":0.0617575657,\"Quantity\":1.000000,\"AccountId\":3}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.1169081586}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.5806014125}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.1952133055}},{\"Currency\":{\"Id\":4,\"Code\":\"GBP\",\"Weight\":0.0455195570}},{\"Currency\":{\"Id\":5,\"Code\":\"JPY\",\"Weight\":0.0617575657}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9433090295}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0566909698}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9346012193}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0653987800}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.0588822079}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.2793891100}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.3054472472}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.3562814342}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.3562814342}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0601777692}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0653987800}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.3054472472}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0566909698}},{\"Country\":{\"Id\":66,\"Name\":\"Spain\",\"Weight\":0.0586347215}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.0588822079}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.0384868695}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.3382713179}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.3054472472}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.3562814342}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":17,\"Isin\":\"CH0244767585\",\"Weight\":0.2500000000}},{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":33,\"Isin\":\"ES0178430E18\",\"Weight\":0.1500000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0500000000}},{\"Instrument\":{\"Id\":103,\"Isin\":\"US5949181045\",\"Weight\":0.3000000000}},{\"Instrument\":{\"Id\":110,\"Weight\":0.1500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":1,\"Code\":\"CHF\",\"Weight\":0.4000000000}},{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.1500000000}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.4500000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9500000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0500000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9500000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0500000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":2,\"Name\":\"Bond\",\"Weight\":0.2500000000}},{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.6000000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.1500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.1500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":66,\"Name\":\"Spain\",\"Weight\":0.1500000000}},{\"Country\":{\"Id\":42,\"Name\":\"Switzerland\",\"Weight\":0.2500000000}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.3000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.8500000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.1500000000}}],\"OptimisationConstraints\":[{\"Id\":1614}]}}},{\"Id\":10,\"Values\":{\"Information\":{\"ProductId\":1},\"MarketValue\":{\"Total\":61472.220000000000,\"Cash\":61282.350000000000,\"Investment\":189.870000000000},\"KPI\":{\"Risk\":0.000266320272,\"InceptionPerf\":0.017230583371,\"DailyPerf\":0.000000000000,\"SharpeRatio\":64.698729988052,\"DailyPerfAmount\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":45,\"Isin\":\"FR0010344960\",\"Weight\":0.7248802792,\"Quantity\":1000.000000,\"AccountId\":51}},{\"Instrument\":{\"Id\":102,\"Isin\":\"US4642888519\",\"Weight\":0.2720310084,\"Quantity\":280.000000,\"AccountId\":51}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0005890465,\"Quantity\":1.000000,\"AccountId\":23}},{\"Instrument\":{\"Id\":112,\"Weight\":0.0024996657,\"Quantity\":1.000000,\"AccountId\":28}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.7254693257}},{\"Currency\":{\"Id\":3,\"Code\":\"USD\",\"Weight\":0.2745306741}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.9999999998}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9999999998}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9969112876}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0030887122}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0030887122}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.7248802792}},{\"Country\":{\"Id\":227,\"Name\":\"United States of America (USA)\",\"Weight\":0.2720310084}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9969112876}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0030887122}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":25,\"Values\":{\"Information\":{\"ProductId\":1},\"MarketValue\":{\"Total\":-42.890000000000,\"Cash\":-42.890000000000,\"Investment\":0.000000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0000000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.0000000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.0000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.0000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.0000000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.0000000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0000000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0000000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.0000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.0000000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0000000000}}]}},{\"Id\":26,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":28,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":29,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":31,\"Values\":{\"Information\":{\"ProductId\":1},\"KPI\":{\"Risk\":0.164024004413,\"InceptionPerf\":0.000000000000,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.000000000000}}},{\"Id\":39,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":40,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":41,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":48,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":49,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":50,\"Values\":{\"Information\":{\"ProductId\":2}}},{\"Id\":51,\"Values\":{\"Information\":{\"ProductId\":2}}},{\"Id\":52,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":55,\"Values\":{\"Information\":{\"ProductId\":3}}},{\"Id\":56,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":57,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":60,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":61,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":10502.110000000000,\"Cash\":0.000000000000,\"Investment\":10502.110000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":111,\"Weight\":1.0000000000,\"Quantity\":1.000000,\"AccountId\":209}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":1.0000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":1.0000000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":1.0000000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":1.0000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":1.0000000000}}]}},{\"Id\":63,\"Values\":{\"Information\":{\"ProductId\":1}}},{\"Id\":65,\"Values\":{\"Information\":{\"ProductId\":2},\"MarketValue\":{\"Total\":367344.370000000000,\"Cash\":356842.260000000000,\"Investment\":10502.110000000000},\"KPI\":{\"Risk\":0.287288189949,\"DailyPerf\":0.000000000000,\"SharpeRatio\":0.000000000000,\"DailyPerfAmount\":-2905.510000000000},\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0755674845,\"Quantity\":3799.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0079883625,\"Quantity\":2.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0032163008,\"Quantity\":3799.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8846385749,\"Quantity\":1990.000000,\"AccountId\":219}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0285892771,\"Quantity\":1.000000,\"AccountId\":220}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":0.9999999998}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.1153614249}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8846385749}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9244325153}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0755674845}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9681944219}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0032163008}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0285892771}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0285892771}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0079883625}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0755674845}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0032163008}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8846385749}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9681944219}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0032163008}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0285892771}}]},\"Reference\":{\"ModelPortfolio\":{\"InstrumentAllocation\":[{\"Instrument\":{\"Id\":20,\"Isin\":\"DE0005557508\",\"Weight\":0.0850000000}},{\"Instrument\":{\"Id\":41,\"Isin\":\"FR0000133308\",\"Weight\":0.0250000000}},{\"Instrument\":{\"Id\":59,\"Isin\":\"LU0061175625\",\"Weight\":0.0400000000}},{\"Instrument\":{\"Id\":94,\"Isin\":\"NL0000235190\",\"Weight\":0.8000000000}},{\"Instrument\":{\"Id\":111,\"Weight\":0.0500000000}}],\"CurrencyAllocation\":[{\"Currency\":{\"Id\":2,\"Code\":\"EUR\",\"Weight\":1.0000000000}}],\"GeofocusAllocation\":[{\"Geofocus\":{\"Name\":\"\",\"Weight\":0.2000000000}},{\"Geofocus\":{\"Id\":2,\"Name\":\"Asia\",\"Weight\":0.8000000000}}],\"SectorAllocation\":[{\"Sector\":{\"Id\":20,\"Name\":\"Energy\",\"Weight\":0.9150000000}},{\"Sector\":{\"Id\":30,\"Name\":\"Materials\",\"Weight\":0.0850000000}}],\"TypeAllocation\":[{\"Type\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"Type\":{\"Id\":4,\"Name\":\"Fund\",\"Weight\":0.0400000000}},{\"Type\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"CountryAllocation\":[{\"Country\":{\"Id\":1,\"Name\":\"Andorra\",\"Weight\":0.0500000000}},{\"Country\":{\"Id\":73,\"Name\":\"France\",\"Weight\":0.0250000000}},{\"Country\":{\"Id\":55,\"Name\":\"Germany\",\"Weight\":0.0850000000}},{\"Country\":{\"Id\":131,\"Name\":\"Luxembourg\",\"Weight\":0.0400000000}},{\"Country\":{\"Id\":163,\"Name\":\"Netherlands\",\"Weight\":0.8000000000}}],\"AssetClassAllocation\":[{\"AssetClass\":{\"Id\":3,\"Name\":\"Equity\",\"Weight\":0.9100000000}},{\"AssetClass\":{\"Id\":18,\"Name\":\"Exchange Traded Funds\",\"Weight\":0.0400000000}},{\"AssetClass\":{\"Id\":1,\"Name\":\"Liquidity\",\"Weight\":0.0500000000}}],\"OptimisationConstraints\":[{\"Id\":2769,\"SecurityConstraints\":[{\"Id\":2769,\"SecurityId\":41,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0000000000},{\"Id\":2769,\"SecurityId\":57,\"MinWeight\":0.0700000000,\"MaxWeight\":0.0770000000},{\"Id\":2769,\"SecurityId\":59,\"MinWeight\":0.1000000000,\"MaxWeight\":0.1200000000},{\"Id\":2769,\"SecurityId\":94,\"MinWeight\":0.5000000000,\"MaxWeight\":0.6000000000},{\"Id\":2769,\"SecurityId\":111,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0900000000}],\"AssetClassConstraints\":[{\"Id\":2769,\"AssetClassId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":1.0000000000}],\"CurrencyConstraints\":[{\"Id\":2769,\"CurrencyId\":2,\"MinWeight\":0.7000000000,\"MaxWeight\":1.0000000000}],\"EconomicalZoneConstraints\":[{\"Id\":2769,\"EconomicalZoneId\":1,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000}],\"SectorConstraints\":[{\"Id\":2769,\"SecuritySectorId\":20,\"MinWeight\":0.2000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecuritySectorId\":31,\"MinWeight\":0.0000000000,\"MaxWeight\":0.0100000000}],\"SecurityTypeConstraints\":[{\"Id\":2769,\"SecurityTypeId\":3,\"MinWeight\":0.6000000000,\"MaxWeight\":0.6050000000},{\"Id\":2769,\"SecurityTypeId\":5,\"MinWeight\":0.1000000000,\"MaxWeight\":0.2000000000},{\"Id\":2769,\"SecurityTypeId\":7,\"MinWeight\":0.0200000000,\"MaxWeight\":0.0200000000}]}],\"Information\":[{\"RiskCategoryId\":4,\"RiskCategoryDefinitionId\":1,\"MinValue\":0.000000000000,\"MaxValue\":0.100000000000}]}}},{\"Id\":67,\"Values\":{\"Information\":{\"ProductId\":1}}}]}"
}
Uploads a file to the server and imports it into the database using BulkCopy mechanism.
The content of the request must be MIME Multipart. The name of the file must contain the name of the table (e.g. Import_Specification_CbsCashTransactions_20180626T083050.csv). Tables used for importing: CbsCashPositions, CbsCashTransactions, CbsSecurityPositions, CbsSecurityPriceHistory, CbsSecurityTransactions.
Maximum file size is 256MB
isComplete | boolean If set to true, it will take the BatchId of the last-imported data and set the LastImportFlag of all data (across potentially multiple imports) with that BatchId to true. |
batchId | string <uuid> By default is null. If isComplete equals true and the batchId is null then a new batchId will be generated internally. If the file is split and isComplete equals false and batchId is null a BadRequest response will be returned, keep in mind that the same batchId should be pass for all parts of a file that was split. If on the last part of a split file you pass isComplete equals true and batchId is null, then a new batchId will be generated internally which will results in a inconsistent import data for the file that was split. |
hasHeader | boolean Default: true By default is true. If it exists and is set to true, the first row of the file will map the columns of the table, otherwise the configuration from the database will be used. |
separator | string By default is null. If it exists and is set, it will be used for import otherwise the parameter in the GlobalSettings table will be used. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "FileName": "Import_Specification_CbsCashPositions_20241218T143537.csv",
- "FileLength": 289644
}
Triggers the import and transformation mechanism that will copy the data from the staging tables to the main internal ones
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Daily | boolean Specifies the type of Import: can be a daily import or an initial import |
HasJoinedAccounts | boolean Nullable Specifies if the bank has joined accounts: multiple clients share the same account or portfolio |
CustodianCountryId | integer <int32> Nullable Only used in the initial import, it adds cash securities in the requested country for simulating cash portfolio positions |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Daily": false,
- "HasJoinedAccounts": false,
- "CustodianCountryId": 42
}
{- "LongRunningRequestId": "string"
}
Matches the transactions received with the orders and sets the status of the later to �Executed� if a match is found. In more detail, the Orders that are in status �Released� are located, their ExternalIds are extracted and matched against the transactions received (i.e. the ExternalId present in the AccountTransaction table which in turn comes from the ExternalTransactionId in the Cash / Securities transactions staging table). If a match is found then the status of the Order is updated from �Released� to �Executed�
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "Orders": [
- 10,
- 38,
- 432,
- 1731
]
}
Deletes a goal template.
id required | integer <int32> The id of the goal template. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets a goal template.
id required | integer <int32> The id of the goal template. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "Name": "<root><en>Name</en></root>",
- "Description": "<root><en>Description</en></root>",
- "CustomAttributes": "{\"Description\": \"Some custom attributes.\"}",
- "ProductId": 1,
- "IsDefault": true
}
Updates a goal template.
id required | integer <int32> The id of the goal template. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Existing goal template.
Name | Array of objects (LocalizedValue) Nullable The name of the goal template. |
Description | Array of objects (LocalizedValue) Nullable The description of the goal template. |
CustomAttributes | string Nullable The customAttributes of the goal template. |
ProductId | integer <int32> The id of the product of the goal template. |
IsDefault | boolean Define if the goaltemplate is default. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": [
- {
- "LanguageCode": "en",
- "Value": "Vacation in Philippine"
}, - {
- "LanguageCode": "de",
- "Value": "Urlaub auf den Philippinen"
}
], - "Description": [
- {
- "LanguageCode": "en",
- "Value": "My vacation description"
}, - {
- "LanguageCode": "de",
- "Value": "Meine Urlaubsbeschreibung"
}
], - "CustomAttributes": "{\"Description\": \"Custom Attributes of Goal Template.\"}",
- "ProductId": 1,
- "IsDefault": false
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes a specific goal of a given contact.
contactId required | integer <int32> The id of the contact. |
goalId required | integer <int32> The id of the goal. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets a specific goal by id and a contact id.
contactId required | integer <int32> The id of the contact. |
goalId required | integer <int32> The id of the goal. |
language required | string The language of the localized resources. |
currencyId | integer <int32> The optional currencyId which will be used for the goals KPI calculation. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 5,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Car",
- "TargetAmount": 100000,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "EURO",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "DueDate": "2025-12-18T00:00:00+00:00",
- "CreateDate": "0001-01-01T00:00:00",
- "FirstInvestmentDate": "2024-11-18T00:00:00+00:00",
- "Image": "Custom.jpg",
- "Status": 1,
- "GoalType": 1,
- "GoalTemplateId": 8,
- "Portfolios": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Portfolio 1",
- "Attributes": "Custom attributes of portfolio goal"
}, - {
- "Id": 5,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Portfolio 5"
}
], - "Attributes": "{\"Description\": \"Build the boat that Jimmy always wanted to have.\"}",
- "Valuation": 250000
}
Deletes the goal template picture for the goal template id specified
goalTemplateId required | integer <int32> Goal TemplateId id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets the goal template picture for the goal template id specified
goalTemplateId required | integer <int32> Goal TemplateId id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ImageContentBase64": "string",
- "IsDefaultImage": true
}
Uploads and stores a goal template picture for the goal template id specified
goalTemplateId required | integer <int32> Goal TemplateId id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Goal template picture payload
ImageContentBase64 | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ImageContentBase64": "string"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets all goal templates of a product.
language required | string The language of the localized resources. |
productId | integer <int32> The id of the product. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "CustomAttributes": "string",
- "ProductId": 0,
- "IsDefault": true,
- "Product": {
- "Id": 0,
- "UId": "string",
- "ProductOfferId": 0,
- "OfferName": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "DefaultOrderBookStatus": {
- "Key": "Reconciliation",
- "Id": 0,
- "Name": "string"
}, - "PortfolioRebalancingType": {
- "Key": "NoRebalancing",
- "Id": 0,
- "Name": "string"
}, - "ProductType": {
- "Id": 0,
- "Name": "string"
}
}
}
]
Creates a goal template.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
New goal template.
Name | Array of objects (LocalizedValue) Nullable The name of the goal template. |
Description | Array of objects (LocalizedValue) Nullable The description of the goal template. |
CustomAttributes | string Nullable The customAttributes of the goal template. |
ProductId | integer <int32> The id of the product of the goal template. |
IsDefault | boolean Define if the goaltemplate is default. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": [
- {
- "LanguageCode": "en",
- "Value": "Vacation in Philippine"
}, - {
- "LanguageCode": "de",
- "Value": "Urlaub auf den Philippinen"
}
], - "Description": [
- {
- "LanguageCode": "en",
- "Value": "My vacation description"
}, - {
- "LanguageCode": "de",
- "Value": "Meine Urlaubsbeschreibung"
}
], - "CustomAttributes": "{\"Description\": \"Custom Attributes of Goal Template.\"}",
- "ProductId": 1,
- "IsDefault": false
}
{- "Id": 0
}
Gets all goals of a given contact.
contactId required | integer <int32> The id of the contact. |
language required | string The language of the localized resources. |
currencyId | integer <int32> The optional currencyId needed for the goals KPI calculation. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "TargetAmount": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "DueDate": "2024-12-18T16:13:43Z",
- "CreateDate": "2024-12-18T16:13:43Z",
- "FirstInvestmentDate": "2024-12-18T16:13:43Z",
- "Image": "string",
- "Status": 0,
- "GoalType": 0,
- "GoalTemplateId": 0,
- "Portfolios": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Attributes": "string"
}
], - "Attributes": "string",
- "Valuation": 0
}
]
Modifies a goal.
contactId required | integer <int32> The id of the contact. |
goalId required | integer <int32> The id of the goal. |
language required | string The language of the localized resources. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the goal to update.
Name | string Nullable The name of the goal. |
TargetAmount | number <double> Nullable The amount to be reached by the investment in the goal. |
DueDate | string <date-time> Nullable The date to reach the goal. |
FirstInvestmentDate | string <date-time> Nullable The first invesment date of the goal. |
Status | integer <int32> The status of the goal (e.g. 1-InProgress, 2-InExecution, 3-Completed, 4-Closed). |
GoalType | integer <int32> The type of the goal (e.g. GeneralInvestment). |
GoalTemplateId | integer <int32> The goal template identifier based on which the goal is created. |
CurrencyId | integer <int32> Nullable The id of the currency on which the goal is created. |
CustomAttributes | string Nullable The custom attributes of the new goal |
UpdateProperties | Array of strings Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Winter Holiday",
- "TargetAmount": 15000,
- "DueDate": "2025-07-06T14:35:37.2293373Z",
- "FirstInvestmentDate": "2024-12-21T14:35:37.2293377Z",
- "Status": 1,
- "GoalType": 1,
- "GoalTemplateId": 8,
- "CurrencyId": 4,
- "CustomAttributes": "{\"Description\": \"Build the boat that Kostas always wanted to have.\"}",
- "UpdateProperties": [
- "Name",
- "TargetAmount",
- "DueDate",
- "FirstInvestmentDate",
- "GoalType",
- "CurrencyId",
- "CustomAttributes"
]
}
{- "Id": 5,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Car",
- "TargetAmount": 100000,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "EURO",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "DueDate": "2025-12-18T00:00:00+00:00",
- "CreateDate": "0001-01-01T00:00:00",
- "FirstInvestmentDate": "2024-11-18T00:00:00+00:00",
- "Image": "Custom.jpg",
- "Status": 1,
- "GoalType": 1,
- "GoalTemplateId": 8,
- "Portfolios": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Portfolio 1",
- "Attributes": "Custom attributes of portfolio goal"
}, - {
- "Id": 5,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Portfolio 5"
}
], - "Attributes": "{\"Description\": \"Build the boat that Jimmy always wanted to have.\"}",
- "Valuation": 250000
}
Creates a new goal for a given contact.
contactId required | integer <int32> The id of the contact. |
language required | string The language of the localized resources. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Properties of the goal to create
Name | string Nullable The name of the goal. |
TargetAmount | number <double> Nullable The amount to be reached by the investment in the goal. |
DueDate | string <date-time> Nullable The date to reach the goal. |
FirstInvestmentDate | string <date-time> Nullable The first invesment date of the goal. |
Status | integer <int32> The status of the goal (e.g. 1-InProgress, 2-InExecution, 3-Completed, 4-Closed). |
GoalType | integer <int32> The type of the goal (e.g. GeneralInvestment). |
GoalTemplateId | integer <int32> The goal template identifier based on which the goal is created. |
CurrencyId | integer <int32> Nullable The id of the currency on which the goal is created. |
Attributes | string Nullable The custom attributes of the new goal |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Holidays in Switzerland",
- "TargetAmount": 10000,
- "DueDate": "2025-12-18T14:35:37.2308668+00:00",
- "FirstInvestmentDate": "2024-12-19T14:35:37.2308679Z",
- "Status": 1,
- "GoalType": 1,
- "GoalTemplateId": 8,
- "CurrencyId": 2,
- "Attributes": "{\"Description\": \"Travel to Switzerland\"}"
}
{- "Id": 5,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Car",
- "TargetAmount": 100000,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "EURO",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "DueDate": "2025-12-18T00:00:00+00:00",
- "CreateDate": "0001-01-01T00:00:00",
- "FirstInvestmentDate": "2024-11-18T00:00:00+00:00",
- "Image": "Custom.jpg",
- "Status": 1,
- "GoalType": 1,
- "GoalTemplateId": 8,
- "Portfolios": [
- {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Portfolio 1",
- "Attributes": "Custom attributes of portfolio goal"
}, - {
- "Id": 5,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Portfolio 5"
}
], - "Attributes": "{\"Description\": \"Build the boat that Jimmy always wanted to have.\"}",
- "Valuation": 250000
}
This service:
Creates, optionally, a new Goal for a given Contact or ContactGroup.
Creates, optionally, a new Real Portfolio of type Real.
Creates a new Portfolio of type Slice linked to the Real Portfolio.
Links the Goal created to the Slice Portfolio created.
Generates (depending on configuration) a Portfolio ChangeSet for the Slice Portfolio.
contactId required | integer <int32> The id of the contact. |
goalId | integer <int32> The ID of the goal to whom the Portfolio of type Slice will be associated |
portfolioId | integer <int32> The ID of the portfolio to whom a goal will be associated |
contactGroupId | integer <int32> The ID of the contact group that has access to the portfolio |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
CurrencyId required | integer <int32> The id of the currency on which the goal is created. |
GoalAttributes required | object (CreateGoal) |
PortfolioAttributes | object (CreatePortfolioRequest) |
GoalAllocation | object (GoalAllocation) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyId": 3,
- "GoalAttributes": {
- "Name": "Holidays",
- "TargetAmount": 15000,
- "DueDate": "2025-01-18T00:00:00+00:00",
- "FirstInvestmentDate": "2019-11-28T16:03:52",
- "Status": 1,
- "GoalType": 1,
- "GoalTemplateId": 15,
- "Attributes": "{\"Description\": \"Build the boat that the Client always wanted to have.\"}"
}, - "PortfolioAttributes": {
- "ModelPortfolioId": 4,
- "Name": "Portfolio From Goal",
- "ProductId": 1,
- "Accounts": [
- {
- "Account": {
- "Id": 2
}, - "IsDefaultCustodyAccount": true,
- "IsPayoutAccount": false,
- "IsPayinAccount": false
}, - {
- "Account": {
- "Id": 1
}, - "IsDefaultCustodyAccount": false,
- "IsPayoutAccount": true,
- "IsPayinAccount": true
}
], - "RebalancingType": "Automatic",
- "InitialInvestmentAmount": 100000,
- "CustomAttributes": "{\"Description\": \"The Portfolio the Client always wanted to have.\"}",
- "ExternalId": "EXT00000001",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2018-12-01T00:00:00",
- "ValidTo": "2021-12-31T00:00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 5,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 1.49,
- "FeeValue": 0.02
}, - {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 1.5,
- "ValueTo": 10,
- "FeeValue": 0.01
}
]
}
], - "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "EsgPreferences": [
- {
- "Id": 0,
- "EsgComponentId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.9,
- "MinThreshold": 1,
- "MaxThreshold": 2
}
]
}, - "GoalAllocation": {
- "AllocationType": "Amount",
- "Allocations": [
- {
- "InstrumentId": 5,
- "Allocation": 1000000
}, - {
- "InstrumentId": 7,
- "Allocation": 400000
}
]
}
}
{- "GoalId": 0,
- "GoalUId": "string",
- "Portfolios": [
- {
- "Id": 0,
- "UId": "string",
- "PortfolioTypeId": 0
}
]
}
Orders a portfolio of type slice. Orders an existing portfolio of type slice that has not been implemented yet or it is implemented and there are only instruments of type liquidity in the portfolio. The portfolio positions can be modified based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). The change will not become effective immediately, only after the order was executed successfully.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
goalId required | integer <int32> The ID of the goal to order |
portfolioId | integer <int32> The ID of the portfolio of type slice to order. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
CurrencyId | integer <int32> Nullable The optional new currency ID of the portfolio. |
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the ordered portfolio should be based on (having the same instruments and allocations). If set, the AllocationsOrder property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the ordered portfolio should be based on (having the same instruments and allocations). If set, the AllocationsOrder property is ignored. |
AllocationsOrder | object (InstrumentSetOrder) Holds information about an order for an instrument set |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyId": 2,
- "ModelPortfolioId": 4,
- "PortfolioProposalId": 25,
- "AllocationsOrder": {
- "AllocationType": "Percentage",
- "Allocations": [
- {
- "InstrumentId": 20,
- "Allocation": 1,
- "CustodyAccountId": 4,
- "FundingAccountId": 2,
- "OrderType": "Market",
- "OrderValidity": "GoodTillCancelled",
- "LimitPrice": 10.25,
- "StopPrice": 8.55
}
]
}, - "ForceOrderGeneration": false
}
{- "OperationResults": [
- {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [
- "string"
], - "PortfolioId": 0,
- "PortfolioChangeId": 0,
- "Result": "Created"
}
}
]
}
Adds a specific amount to a portfolio of type slice. Doesn't trigger a cash transaction from an external account to the portfolio's cash account. Instead cash is moved from the portfolio's cash account to the custody account by issuing buy orders. The new amount will be distributed amongst the portfolio securities based on their allocation values and a buy order will be created. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the goal |
goalId required | integer <int32> The ID of the goal to top up |
topUpAmount | number <double> The amount to add to the portfolio in portfolio currency. Must be > 0. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
portfolioId | integer <int32> The ID of the portfolio of type slice to top up |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResults": [
- {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [
- "string"
], - "PortfolioId": 0,
- "PortfolioChangeId": 0,
- "Result": "Created"
}
}
]
}
Sells a specific amount from a portfolio of type slice. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The reduction amount will be distributed amongst the portfolio securities based on their allocation values and a sell order will be created. Depending on the allocation values and actual prices it is possible that not the exact amount will be sold. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
goalId required | integer <int32> The ID of the goal to sell from |
amount required | number <double> The amount to sell from the portfolio in portfolio currency. Must be > 0. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
portfolioId | integer <int32> The ID of the portfolio to sell from |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResults": [
- {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [
- "string"
], - "PortfolioId": 0,
- "PortfolioChangeId": 0,
- "Result": "Created"
}
}
]
}
Sells a whole portfolio of type slice. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
goalId required | integer <int32> The ID of the goal to sell from |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
portfolioId | integer <int32> The ID of the portfolio to sell completely |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResults": [
- {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [
- "string"
], - "PortfolioId": 0,
- "PortfolioChangeId": 0,
- "Result": "Created"
}
}
]
}
Gets a security by ID and returns all details about it.
This API is deprecated. Use GET /v1.0/securities/{securityId}/kpi/calculate instead.
securityId required | integer <int32> |
language required | string |
currencyId | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ExpectedRisk": 0,
- "ProjectedExpectedReturn": 0,
- "CalculatedRisk": 0,
- "CalculatedExpectedReturn": 0,
- "SharpeRatio": 0,
- "DownsideVolatility": 0,
- "SortinoRatio": 0,
- "Story": "string",
- "Factsheet": "string",
- "Kiid": "string",
- "MaxPrice": 0,
- "MinPrice": 0,
- "YearToDateReturn": 0,
- "CalculationCurrency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string",
- "UId": "string"
}, - "Issuer": "string",
- "CumulativeReturns": [
- {
- "TimeUnit": "Day",
- "NumberOfTimeUnits": 0,
- "Return": 0
}
], - "SecurityComponents": [
- {
- "SecurityId": 0,
- "ChildSecurityId": 0,
- "Allocation": 0
}
], - "HomeStockExchange": {
- "Id": 0,
- "MarketCode": "string",
- "Description": "string",
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}, - "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}, - "Id": 0,
- "Name": "string",
- "Isin": "string",
- "TradingPrice": 0,
- "FaceValue": 0,
- "ExternalId": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Type": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "BondExtension": {
- "MaturityDate": "2024-12-18T16:13:43Z",
- "BondCouponFrequency": {
- "Key": "Quarterly",
- "Id": 0,
- "Name": "string"
}, - "CouponType": {
- "Key": "Fixed",
- "Id": 0,
- "Name": "string"
}, - "Coupon": 0,
- "InitialSize": 0,
- "IncrementSize": 0,
- "IssueAmount": 0,
- "IssuerType": {
- "Key": "Government",
- "Id": 0,
- "Name": "string"
}, - "IssueDate": "2024-12-18T16:13:43Z"
}, - "OptionExtension": {
- "Strike": 0,
- "IsPut": true,
- "MaturityDate": "2024-12-18T16:13:43Z",
- "OptionExerciseType": {
- "Key": "European",
- "Id": 0,
- "Name": "string"
}
}, - "FutureExtension": {
- "MaturityDate": "2024-12-18T16:13:43Z"
}, - "FundExtension": {
- "SecurityId": 0,
- "InceptionDate": "2024-12-18T16:13:43Z",
- "OfferingFromDate": "2024-12-18T16:13:43Z",
- "OfferingToDate": "2024-12-18T16:13:43Z",
- "Cap": 0,
- "CurrentFill": 0,
- "MinimumInvestmentAmount": 0,
- "MinimumIncrementAmount": 0,
- "FundTypeId": 0,
- "FundManagementTypeId": 0,
- "FundInvestmentTypeId": 0,
- "FundType": {
- "Key": "MutualFund",
- "Id": 0,
- "Name": "string"
}, - "FundManagementType": {
- "Key": "Passive",
- "Id": 0,
- "Name": "string"
}, - "FundInvestmentType": {
- "Key": "OpenEnd",
- "Id": 0,
- "Name": "string"
}
}, - "Ratings": [
- {
- "Id": 0,
- "Value": "string",
- "Color": "string",
- "Agency": {
- "Id": 0,
- "Name": "string",
- "Description": "string"
}
}
], - "Focus": {
- "Id": 0,
- "Name": "string",
- "Parent": { }
}, - "SecurityStockExchanges": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "Ticker": "string",
- "IsDefault": true,
- "SecurityStockExchangeId": "string",
- "PriceFeedIntegrationIdentifier": "string",
- "PriceFeedIntegrationIdentifierType": "string",
- "StockExchange": {
- "Id": 0,
- "MarketCode": "string",
- "Description": "string",
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
}
], - "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": true,
- "CustomAttributes": "string",
- "TradingUnit": 0,
- "RoundingLot": 0,
- "BenchmarkId": 0,
- "Factor": 0,
- "IsPricePercentage": true,
- "LogoUrl": "string",
- "UId": "string"
}
Searches for securities in the product instrument universe for a number of passed criteria. If multiple search parameters are passed then all of them must match.
productId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Page | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
SearchTerm | string Nullable |
SecurityTypeIds | Array of integers <int32> Nullable |
SecuritySectorIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable |
AssetClassIds | Array of integers <int32> Nullable |
CountryIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
ContactId | integer <int32> Nullable |
IsActive | boolean Nullable |
IsInvestable | boolean Nullable |
RatingAgencyIds | Array of integers <int32> Nullable |
RatingIds | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Page": 1,
- "PageSize": 10,
- "SearchTerm": "Index",
- "SecurityTypeIds": [
- 10
], - "SecuritySectorIds": [
- 172
], - "CurrencyIds": [
- 2,
- 4
], - "AssetClassIds": [
- 3,
- 12
], - "CountryIds": [
- 11,
- 14,
- 47,
- 55,
- 75
], - "RiskCategoryIds": [
- 1,
- 2,
- 3,
- 4,
- 5,
- 6,
- 7,
- 8,
- 9,
- 10
], - "ContactId": 2,
- "IsActive": true,
- "IsInvestable": false,
- "RatingAgencyIds": [
- 2
], - "RatingIds": [
- 30,
- 32
]
}
{- "Results": [
- {
- "Id": 0,
- "Name": "string"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Loads and saves all the available price history from a price feed provider by security IDs. Price history queried for a security varies depending on the security date range.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Contains the list of security IDs to import price history for. If security IDs list is passed as an empty list then this will trigger the import of price history for all securities from database which have a PriceFeedIntegrationIdentifier and a PriceFeedIntegrationIdentifierType.
SecurityIds | Array of integers <int32> Nullable The list of security IDs to import price history for |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SecurityIds": [
- 7,
- 94
]
}
{- "LongRunningRequestId": "string"
}
Saves the latest securities prices provided by the User. Note that these are not saved in the securities prices history.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Contains a list of securities, each with price and update date.
SecurityId | integer <int32> |
Price | number <double> |
Date | string <date-time> |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "SecurityId": 0,
- "Price": 0,
- "Date": "2024-12-18T16:13:43Z"
}
]
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes the profile picture of the member specified
memberId required | integer <int32> Member id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Returns the stored profile picture of member specified
memberId required | integer <int32> Member id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ImageContentBase64": "iVBORw0KGgoAAAANSUhEUgAAALgAAAA8CAYAAADVEnAJAAAOvklEQVR42u1dCZBcRRluyM4Sbg9QuUTFYAhy7Zs3G2Nw5r2ZTWKMWBCXQ5QzIncEFIqjGGtnZpdwaEUOIYcFlBwVRBA5wh7hUIIQCFgkJCAWBUWSnZ3N9d7MXgk7/p/sZje72/3umR2rv6quDOyb1zXd3/v77+///37MD0STxapYY6FWT+ev0zP5h7W0sTqWyWdjGaNA/13UU0Yf/ZvT08bbWjr/GH2+Qc8YJyv3FUNMQmK8Qk8XIrGM+Qc9ld8CIjttn33PvC/elD+JSUiMFxAp64igL4GkvrW08TytADVMouIQfnRucazGKg11qe6v62nzryBkIC1l9NO/d0eT2f2YhCR4ia32T2MpMw8iBt20TP79eIN5HJOQBA8a9cuKE8h1uAfEK3EzY+n8TCYhCR4QoI5MJMv9pF1SxlLGTrLyK+nzQvreZfGUeYbWWDhFy5inU7uCFJS7Ymnjdbgidu6Ha/GAMQlJ8ADIXaWlzSdsqiHv6JnCL6Y3bfu8LV8+aX6JHoD59L1/Czadb8cbt3+RSUiCBwHId5YWNmN8AuucTBb3dPsQkfszDxr57vc23pLklgQPDES68yw3gqn8I7OSnQcw+xBb9LTxDO6LIJEktyR4sFJgyuiyUDluYsXiHsxHYBUgCfKXM5LbvsAkJMGDAEhL7sFyC+t9A5OQqESCQ5YTk9tcymC5JSQqjeAgLiQ+AcHXz0kW92ESEpVIcGQDihUTM84kJCqV4JAFBZvKFiYhUakER7SQ8rc38wgeb8zPYhWOjkTtpGxcvSQbDy+m1tauK6vQ8JnaEvytI64ezQJCT3P1pL7mqkt2tExY3NsSatvRGlqF9r/PzROW4G89LdWB9Z+4ZcuBlN58KgXvMhRge4hW5KeQm09y7+0UMZ47bUFu/3ITvKgooQ5N/V5WV69r19WlHbr6JM3LUzQvD3bo4Ztpvuren/XNvZhTaE0Fhe+eGBsrNVyOAcvGI+eAyDRIRTutPa6+SQN8Hr7ruf83WGhnS+icATIX7TQi+5u9raHz8F2fYho1tAI/SkG5XougXYGu/f30jHHwZ98z6xFNHtlQ0OI3wbNR9Ssd8fACGv+c9fyEt+DaDVHlIGYXlDNyNd89MRezCkQ2oUzPxpW1GBQ3LauF34U1YS7R11I1nci6FqR11ya829dW5bp/BMvIOD3gNMktlsp3YsUma38xJ4XiDb8IXkyyPTviylU0znmn8wOi5+Lq2fYseNpcwiV4On9ORVltxvYgl+P6dk39lDc4Dqx5Py2TN+Ke9sUotgeR+3qywp+CqF5ab3Oov6+16kbc0+mKrGWMj8VkFifNYd8VJMGz0Sn7tevhp73OEc317XhQmAj01L7M+7FY4iqJ3DRoC/HDfW26ejfubYfcRMyFIKfP7W67JEetK1KN/UhZDorgm+qO35es9t/9mh/MOeZHRPC1vB/kNS8kiEGmDfGdbAzA2uIHB9RuYhaAtQUhg2i0Klj2rzWYx9LYbMcYjVeCg4g0lo/5PT8QCRgPouWsPlmsHm8ER9kcG4FcXInBpRBbYuUt2p1fDLUEu3G03AxlclZXLidfcI2lu5IIRxkHpI7E4FJY+NVv0UNwMdSS/mfZXmg9y6sn0/+7nPz1NZbuSnMVt38E4UgdWWdhGDYTQW9DTS1yjqK3FA5PpIzptM/6DSkpG0pB8A49cqF476P20ib/PrruZLgxeCA2zjrx4Jwe/iEUFe53NbUHc/l/QXC4VLtZhfop1UTA9fyBU7rIus/DYIk3POqVGGD+UqiuG0tdKS5j1UTQ9QJydpFPPq9YFPdPVvpKuq5X8ICs46krRNpGYYJc2rwX2Z+iB4QegN8FSfCt0RM+l9WUzSIFC3IuE4B87rm8OYLkizmucBcFzVjFhoEUj/MFT3YhW6d8l9kEtFYRySE7shHobQudzyMlEbbQ93yV7f6JxHUikkN2ZCNwcjp/CG0MewRjdq13Rc07wbH558+TsjI3bZotLR6GSKCuJLxvMsvvovyTDQNcD94PJinpJ8wh4MYIBnDUBMP14BKyOeS4f7gxXCveEhrVP7kYacFY/dFpThK0bl8JPiQJfsix3FtziZMOtRUI0iP1NAcvCx6U50Z9EVp3UDJhMMdL5FvZAOB3Cfy5F/huiVifFQWHslrNUYPXwocWWO8XikV3/YuCQ91tex21e5Kc8RHvYCV7ZYSjVwRaJbv9JHhOq1UEKtWNTACQnyKZSZJ+N1htNiEPI3A0kuBXCXy3JaxMgFrCmbiHdi17evgyrvXWwqcwlyBLcBZ3IBPqz4dZ28u41rat2nX/O9tCZwl8+l39JxqMYwTW9jbmElrauN9PgtO4Xc0dz5k1h4yltkA4oKjlsva4ssOumgL5sTNRe8yocK5gkDahdrIsBE/lV3Aeuswwv24xZ2PZbZW3YBmI0JSdPF18mHqymEPCbqgkrjX9F9h+tALs5OnidsoL441d33FN8Ixxmq8E18L3c9yT9WwY4IfTnF4KVcsBqfOksNzbrtcezy0XQ4iWa8Ub87NZiYGDOXkBCy1lnjWM4G28HTnzCAyylZ+HZCleTgnzCJ50SMTf1T8edt4pYbMW9rt+wKJN3V/zkeCYpxWisdykqcfCcND/M+0SG6oWEfuKLQnlQGYFHKIpkOVWlCF9V+MXPG/b5YPCV+YQ/FnPBNfUFt6Of/Aa+MocC+65fyJyC8eC7+ofR91x3LgO5gGQh/0kOAwOL+eHiPqibVJjVdXVx3NaRIcb4+ikWPyA8ZIyi90/J0/io+Flc7SRfL3MBH+9PAQXGyYcX+31XBxfCa6pq71FK5V22m81dEYjh3soODZfEZD8g6Gc4WCBCBtP10VK5wiJsJWzm15dAhcFJGzlBGVWl8hFWcBLmPKyd0osKBzqJ8Fhpd0lvCkv0UbzDATz/DkWWXxcxJ9KUXQs0mGj6UJ4N99OVxbxQr4fT526N3MJbHY4m0y0O4dp4Is4JOztX8lc99//D7Y/d5PZEtrVP04U449V/kTmElixfd1k6uEHnGwa6fp72uM1xwVwbIT5tEVlfUPA5L5Q0PerbASQZCNIpZzLXAIBIkGu+PmD16EShx+UqXbdPwJEvPsicjp4HR54QZAuyVwCK2WQMiHPH0deUOesyAEsKGD3jOoOi0hiEx6GYI5oNnYKJuz7Y4RtjxaFf90GehCx5N1384zwEYPXInFKkCS10m2gBxFL3n37l088wl65obHRzUkIyFmh72/1VUWpU08UqCEbc3pEczVX0ahzN4xkwZ9Zp6yaT/l1ChV8RawM4mQh4znOQ8XdoaMhyYo5BHRYUSBhDF/5TUE0c56LaqBLBQ/NqP5xaq+PwR5Y79/6HqpHrr6mvMfL1OzUlYiLYNxs3JMs/zRmFzz5iSdF0eBe4GUzg+oT5JZY9LV1RqrrCD4h1XNF6ZftCTVuv9RNnUkD3ufE7aEEqHMFBO+lByDuYGM5kxSYPiduj9aw/VuiI6kRDGI2gcNUA0q2gh8+X+CifIC0WGYTIDU088HwPOo0P4xGJzo9+fVxm/khHyALDTkMzAYQgIil8z/AKmDjBNtPEWiyLi5W1opIjgy0Yn09t3gaf4OfKAoLw22B+zBWcTHqL0UkRyospdVy+8ff6Jqridw7RIlW6J/j3i21cCtTotRnuDp0j2sw3kERfMMcZR8a30944zswh0dbVW1hVUaketQ9oHrpNTUMsE3EjPkXh7na/6LBXITBQqIWjiRA5BEH4mO5pL83O3wVyoV2i4yH6jCFA3hlpx6ZgqcdDZ9hWRAVsyh46MPgiYqMreow8RCA6D2t1VMoFD8RDZ8pn2U+cr0tCh766P7c/lENj7QK8YprfohXPWpN+RPgmyNanGjYPglKDOatFAUPNM6nWigoPVCp2hORqZAGB0ndqU89jKz0BXBHxd8PZ/EgOTozhbOjDrRhs+lkaQWyeuTaoErWoNbYSHO9NqiSNag11tFoI4p3ko7nkjUAIXlbGjgMlqZ0QjZ0cP1stwrHmeRzG6UgN1QBaPKuKuq18B1+kxupmgywV3R8h+/kbq1KOvGhYRzGM8GhfJA1fsLPOcJGFRbe4+lIXV+lH/nnYAluLOdsKG2TPKer1wwFadw3+O65ePgi5gAgORHyGk6QhtNEvnvoIhcq2GxyObZ5Wz2N570TXLxvGsoE9dhQtaUrP/Y1EQoJWD4XMayDv+6Xvr4pVlOLSh8PVvvVrBY5gblE34qq2qFKH1ftVQrouO4/3tT9DRSGuKh33UZRzDm+H/wjDqjlPLiOrw3lf/sMRNEGihJyLi1FD97ihjexuX3PDyBURhLq6TQQrzhIwXyRdvo/GlIr3APKCEUkT9/RHHrFAbFfJCnQl/5hLKBWoSTRptV+kIh92EA++CVjX2eu9PvoNqS74uxBUkE2OTlij75zJsapJId3Qs8m1eTXyFdBUTB29FBLoM/iXDxo5tipg9CoIcQyWso3Gm/UTjpyoDj5LmQagvRo9PkZ7NpRTIydOgsI/W0Tj0SInaS+u5BpCNKjUT75M8gtQTFxf+vehwX5ahpYZZQnwrKTOvYaXseOyh2oKNFb87uVeUEF47mQowj+yGlvjNXcRCUR0STXJY1Tr2gz+g65iR+hlhPJc6juoTn81aa68LeZhIQX8I6QwAPBJCTGA6BzM5eAdZfvaJIYd0BwjqLKZyPzEq9gd5cbZBxErsiOsQguX68uURagSATheFTyDN84ujnXBke5ceo8+1D0wiQkSgmUG4LMHNXjP2TNv+xAAj6edyaKljb/xiQkyvEKGlJG3hFo2+/h/BR7D0q+XVCXO4dJSJQD5HfHrGIOJOHeEc0Yk6GPD88apXjGVBzwJA7xG6vkO1Ilyv2mvFvtvqaE/l1DhH8f7oidIFC8saAyCYlyAtaYk97ssZnzmYRESSE+sOdhHwl+M5OQGG+vZYfVJVmvy0Py2xa8SpBJSJQb4vMFzaXIBXJAbAMvh0Wwh0lIVAJAVgr4zBtwXdbgRVWovUTgBrIgop44Ag7pynW39e/LJCQkKgP/BTwUobIIDirVAAAAAElFTkSuQmCC",
- "IsDefaultImage": false
}
Uploads and stores a profile picture of the member specified
memberId required | integer <int32> Member id |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ImageContentBase64 | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ImageContentBase64": "string"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Returns top result members given a look up string. The endpoint could potentially present outdated information (following a name-change) or inactive members.
lookUpTerm | string The look up term. |
limit | integer <int32> Limit results up to 25 records. If not passed, 10 records are returned. |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Members": [
- {
- "MemberId": 23,
- "FirstName": "General",
- "LastName": "Manager",
- "Email": "generalmanager@additiv.ch",
- "BankBranch": {
- "Id": 1,
- "Name": "Branch 1"
}, - "IsActivated": false
}
]
}
Returns a member’s profile details
memberId required | integer <int32> Member ID |
language | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "InternalUserId": "string",
- "FirstName": "string",
- "LastName": "string",
- "Email": "string",
- "Phone": "string",
- "Mobile": "string",
- "SuperiorIds": [
- 0
], - "HasProfilePicture": true,
- "Branch": {
- "Id": 0,
- "Name": "string"
}
}
Gets all the contacts based on member role hierarchy
memberId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "ContactName": "string",
- "MemberId": 0,
- "ContactId": 0
}
]
Enrolls new device for push notifications.
contactId required | integer <int32> The contact identifier |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request data.
DeviceToken | string Nullable |
PushToken | string Nullable |
Platform | string (DevicePlatform) Enum: "iOS" "Android" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "DeviceToken": "string",
- "PushToken": "string",
- "Platform": "iOS"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Calculates one of the following InitialAmount, RecurringAmount, TargetAmount or TargetYears
Accept-Language | string The ISO 639-1 language to use for localizable data. |
An object containing PaymentFrequency, ExpectedReturn and 3 of the following parameters: InitialAmount, TargetAmount, TargetYears and RecurringAmount.
InitialAmount | number <double> Nullable |
RecurringAmount | number <double> Nullable |
TargetAmount | number <double> Nullable |
ExpectedReturn | number <double> Nullable |
TargetYears | number <double> Nullable |
PaymentFrequency | string (PaymentFrequency) Enum: "Monthly" "Quarterly" "Semesterly" "Yearly" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InitialAmount": 100000,
- "TargetAmount": 1000000,
- "ExpectedReturn": 0.075,
- "TargetYears": 5,
- "PaymentFrequency": "Monthly"
}
{- "InitialAmount": 0,
- "RecurringAmount": 0,
- "TargetAmount": 0,
- "TargetYears": 0
}
Calculates the optimal allocation for the parameters passed by the user
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Securities required | Array of integers <int32> |
CurrencyId required | integer <int32> |
OptimizationMode required | string (OptimizationMode) Enum: "MeanVariance" "BlackLitterman" |
TargetVolatility required | object (TargetVolatility) |
Years | integer <int32> Nullable |
OptimalAllocationMode | string (OptimalAllocationMode) Enum: "MaxSharpeRatio" "MinSharpeRatio" "MaxReturn" "MinReturn" "MaxVolatility" "MinVolatility" "MidVolatility" |
RiskFreeRate | number <double> Nullable |
Constraints | object (Performance.Abstractions.OptimizationConstraints) |
ProjectedExpectedReturns | Array of objects (ProjectedExpectedReturn) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Securities": [
- 5,
- 6,
- 7,
- 80
], - "CurrencyId": 2,
- "OptimizationMode": "MeanVariance",
- "TargetVolatility": {
- "MinVolatility": 0,
- "MaxVolatility": 1
}, - "Years": 10,
- "OptimalAllocationMode": "MinSharpeRatio",
- "RiskFreeRate": 0,
- "Constraints": {
- "SecurityConstraints": [
- {
- "SecurityId": 5,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityId": 6,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityId": 7,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityId": 80,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 3,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CurrencyId": 2,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CurrencyId": 4,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CurrencyId": 8,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "AssetClassConstraints": [
- {
- "AssetClassId": 15,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "AssetClassId": 38,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "AssetClassId": 63,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 28,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecuritySectorId": 99,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecuritySectorId": 192,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityTypeId": 3,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityTypeId": 4,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "ContinentId": 3,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "ContinentId": 6,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "CountryConstraints": [
- {
- "CountryId": 14,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CountryId": 42,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CountryId": 55,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CountryId": 227,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0,
- "MaxWeight": 1
}
]
}, - "ProjectedExpectedReturns": [
- {
- "SecurityId": 5,
- "Return": 0.0023
}, - {
- "SecurityId": 6,
- "Return": 0.0014
}
]
}
{- "ExpectedReturn": 0,
- "ExpectedRisk": 0,
- "SharpeRatio": 0,
- "Allocations": [
- {
- "Id": 0,
- "Allocation": 0
}
], - "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
Calculates the efficient frontier (i.e. optimal allocations for different levels of target returns) for the parameters passed by the user.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Securities required | Array of integers <int32> |
CurrencyId required | integer <int32> |
OptimizationMode required | string (OptimizationMode) Enum: "MeanVariance" "BlackLitterman" |
Years | integer <int32> Nullable |
RiskFreeRate | number <double> Nullable |
Constraints | object (Performance.Abstractions.OptimizationConstraints) |
ProjectedExpectedReturns | Array of objects (ProjectedExpectedReturn) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Securities": [
- 5,
- 6,
- 7,
- 80
], - "CurrencyId": 2,
- "OptimizationMode": "BlackLitterman",
- "Years": 10,
- "RiskFreeRate": 0,
- "Constraints": {
- "SecurityConstraints": [
- {
- "SecurityId": 5,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityId": 6,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityId": 7,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityId": 80,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 3,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CurrencyId": 2,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CurrencyId": 4,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CurrencyId": 8,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "AssetClassConstraints": [
- {
- "AssetClassId": 15,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "AssetClassId": 38,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "AssetClassId": 63,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 28,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecuritySectorId": 99,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecuritySectorId": 192,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityTypeId": 3,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "SecurityTypeId": 4,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "ContinentId": 3,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "ContinentId": 6,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "CountryConstraints": [
- {
- "CountryId": 14,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CountryId": 42,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CountryId": 55,
- "MinWeight": 0,
- "MaxWeight": 1
}, - {
- "CountryId": 227,
- "MinWeight": 0,
- "MaxWeight": 1
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0,
- "MaxWeight": 1
}
]
}, - "ProjectedExpectedReturns": [
- {
- "SecurityId": 5,
- "Return": 0.0023
}, - {
- "SecurityId": 6,
- "Return": 0.0014
}
]
}
{- "AllocationSets": [
- {
- "ExpectedReturn": 0,
- "ExpectedRisk": 0,
- "SharpeRatio": 0,
- "Allocations": [
- {
- "Id": 0,
- "Allocation": 0
}
], - "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
], - "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
Gets the sum of all account balances from all the accounts that belong to contacts which have the requested relationship manager id
memberId required | integer <int32> The id of the relationship manager |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "MemberId": 1,
- "Value": 500250
}
Gets the performance of top and bottom securities, portfolios and contacts for an RM. Returns top and bottom performers for securities, portfolios and contacts for an RM.
memberId required | integer <int32> The member ID of the RM |
currency required | integer <int32> The currency ID to be used for the calculation |
nrOfDays required | integer <int32> The number of days in the past to calculate the top performance for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SecurityPeformanceTop": {
- "TopPerformers": [
- {
- "Id": 1,
- "Name": "Apple",
- "Performance": 0.23,
- "Isin": "123"
}
], - "BottomPerformers": [
- {
- "Id": 1,
- "Name": "Google",
- "Performance": -0.235,
- "Isin": "1234"
}
]
}, - "PortfolioPerformanceTop": {
- "TopPerformers": [
- {
- "PortfolioId": 18,
- "Performance": 0.0283294516854811,
- "ExternalId": "EXTERNAL001",
- "ProductId": 1001,
- "ProductName": "Instrument",
- "CurrencyId": 2,
- "CurrencyCode": "EUR",
- "ContactId": 0
}, - {
- "PortfolioId": 1,
- "Performance": 0.00353600309876413,
- "ExternalId": "EXTERNAL002",
- "ProductId": 1002,
- "ProductName": "Basic",
- "CurrencyId": 3,
- "CurrencyCode": "USD",
- "ContactId": 0
}
], - "BottomPerformers": [
- {
- "PortfolioId": 6,
- "Performance": -0.553951143447919,
- "ExternalId": "EXTERNAL003",
- "ProductId": 1003,
- "ProductName": "First product",
- "CurrencyId": 4,
- "CurrencyCode": "GBP",
- "ContactId": 0
}, - {
- "PortfolioId": 8,
- "Performance": -0.0146441799999965,
- "ExternalId": "EXTERNAL004",
- "ProductId": 1004,
- "ProductName": "Second product",
- "CurrencyId": 1,
- "CurrencyCode": "CHF",
- "ContactId": 0
}
]
}, - "ContactPerformanceTop": {
- "TopPerformers": [
- {
- "ContactGroupId": 10,
- "ContactId": 13,
- "ContactName": "John Doe",
- "Performance": 0.0226991663291296
}, - {
- "ContactGroupId": 1,
- "ContactId": 4,
- "ContactName": "Michael David",
- "Performance": 0.00353600309876413
}
], - "BottomPerformers": [
- {
- "ContactGroupId": 4,
- "ContactId": 7,
- "Performance": -0.231325328776295
}, - {
- "ContactGroupId": 4,
- "ContactId": 1094,
- "Performance": -0.231325328776295
}
]
}
}
Calculates the following KPIs: Expected Return, Cummulative Return, Volatility, Sharpe Ratio, Maximum Drawdown, Time To Recovery, Value At Risk, Downside Volatility, Sortino Ratio and Historical Performance.
Note that if Allocations are passed by the User and their sum is not 100% (but relatively close to 100%), a rounding algorithm is in place to adjust them so that they add up to 100%.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
An object containing: a set of instruments + allocations, number of years used for calculation and the calculation interval
InstrumentSet required | object (InstrumentSet) |
Years | integer <int32> Nullable The number of historical years to use for the calculation. If not passed the system default value 'HistoricalPerformanceYears' in group 'Performance' of the Global Settings will be used. |
Days | integer <int32> Nullable The number of historical days to use for the calculation of the Historical Performance. If not passed the 'Years' value will be used. If 'Years' is not passed either the system default value 'HistoricalPerformanceYears' in group 'Performance' of the Global Settings will be used. |
CalculationInterval | string (CalculationInterval) Enum: "Daily" "Weekly" "Monthly" "Yearly" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InstrumentSet": {
- "CurrencyId": 1,
- "Allocations": [
- {
- "InstrumentId": 1,
- "Allocation": 0.2
}, - {
- "InstrumentId": 2,
- "Allocation": 0.3
}, - {
- "InstrumentId": 3,
- "Allocation": 0.5
}
], - "AllocationType": "Percentage"
}, - "Years": 10,
- "Days": 300,
- "CalculationInterval": "Monthly"
}
{- "ExpectedReturn": 0.13766208859679047,
- "CummulativeReturn": 1.7041907211033687,
- "Volatility": 0.20459221768285565,
- "SharpeRatio": 0.6728608260661433,
- "MaximumDrawdown": 0,
- "TimeToRecovery": 0,
- "ValueAtRisk": 0,
- "DownsideVolatility": 0.21099221768285564,
- "SortinoRatio": 0.13766208859679047,
- "HistoricalPerformance": [
- {
- "SeriesType": "Portfolio",
- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Amount": 836009.40851,
- "Value": -0.031585056261762556
}, - {
- "Date": "2018-04-25T00:00:00",
- "Amount": 837853.16027,
- "Value": 0.18888727230379487
}, - {
- "Date": "2018-04-26T00:00:00",
- "Amount": 834097.90501,
- "Value": -0.2601590090298256
}
]
}
]
}
Returns the evolution (i.e. time-series) of the Assets Under Management of the Member in question. If the 'hierarchy' property is not passed then the endpoint does not account for the hierarchy of the Member; if the 'hierarchy' attribute is passed as true on the other hand, the hierarchy of the Member is accounted for. Note the time series returned is calculated in the application currency, unless the 'currencyId' attribute is passed by the user.
memberId required | integer <int32> The Id of the member |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object containing the relationship manager id, the start date and the end date
StartDate | string <date-time> Nullable The First day of the balance history requested |
EndDate | string <date-time> Nullable The Last day of the balance history requested |
Hierarchy | boolean The flag which include or exclude member hierarchy |
CurrencyId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "StartDate": "2024-12-18T16:13:43Z",
- "EndDate": "2024-12-18T16:13:43Z",
- "Hierarchy": true,
- "CurrencyId": 0
}
{- "Values": [
- {
- "Id": 0,
- "Name": "string",
- "MemberId": 0,
- "Value": 0,
- "Date": "2024-12-18T16:13:43Z",
- "Percentage": 0,
- "Color": "string"
}
], - "Currency": {
- "Id": 0,
- "UId": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
}
Calculates a projection for a given set of parameters. The endpoint covers two distinct use-cases:
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
InitialInvestmentAmount | number <double> Nullable The optional initial investment amount. |
MonthlyContributionAmount | number <double> Nullable The optional monthly contribution amount. |
Fee | number <double> Nullable The optional fee to use for the calculation. |
ProjectionYears | integer <int32> Nullable The number of projection years (years in the future) to use for the calculation. |
HistoricalYears | integer <int32> Nullable The number of historical years to use for the calculation. |
CurrencyId | integer <int32> The currency that should be used for the calculation. |
InstrumentAllocations required | Array of objects (InstrumentAllocation) The instruments and their allocations the calculation should be done for. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InitialInvestmentAmount": 1000,
- "MonthlyContributionAmount": 100,
- "ProjectionYears": 10,
- "HistoricalYears": 10,
- "CurrencyId": 1,
- "InstrumentAllocations": [
- {
- "InstrumentId": 1,
- "Allocation": 0.2
}, - {
- "InstrumentId": 2,
- "Allocation": 0.3
}, - {
- "InstrumentId": 3,
- "Allocation": 0.5
}
]
}
{- "ProjectionSeries": [
- {
- "ProbabilityPercentage": 0,
- "Name": "string",
- "SeriesType": "Security",
- "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Amount": 0,
- "Value": 0,
- "CashFlow": 0,
- "AdditionalValue": 0
}
]
}
], - "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
Calculates and saves performances in every currency found in Securities and ProductOfferCurrency tables for a given interval
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The interval for which the calculation will trigger
From | string <date-time> Nullable |
To | string <date-time> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "From": "2014-12-18T00:00:00+00:00",
- "To": "2024-12-17T00:00:00+00:00"
}
{- "LongRunningRequestId": "string"
}
Calculates and save performances for a single security in the security currency and every currency found in the ProductOfferCurrency table for a given interval
securityId required | integer <int32> The id of the security |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The interval for which the calculation will trigger
From | string <date-time> Nullable |
To | string <date-time> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "From": "2014-12-18T00:00:00+00:00",
- "To": "2024-12-17T00:00:00+00:00"
}
true
Calculates and returns the correlation matrix of returns for the set of securities passed
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request object containing securities Ids, number of years and calculation interval
InstrumentSet required | object (Performance.Abstractions.CalculateSecuritiesCorrelations.InstrumentSet) |
Years | integer <int32> Nullable The number of historical years to use for the calculation. If not passed the system default value 'HistoricalPerformanceYears' in group 'Performance' of the Global Settings will be used. |
CalculationInterval | string (CalculationInterval) Enum: "Daily" "Weekly" "Monthly" "Yearly" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InstrumentSet": {
- "CurrencyId": 1,
- "InstrumentIds": [
- 5,
- 6,
- 7,
- 8
]
}, - "Years": 10,
- "CalculationInterval": "Monthly"
}
{- "Result": [
- {
- "InstrumentIdBase": 0,
- "InstrumentIdCounter": 0,
- "Correlation": 0
}
]
}
Get the performance attribution of a model portfolio vs. another model portfolio. Note that:
- if a currencyId is not passed then the currency of the system will be taken as the default.<nr />
- if a FromDate / ToDate are not passed then all available data will be returned
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request parameters
CurrencyId | integer <int32> Nullable |
ModelPortfolioId1 | integer <int32> |
ModelPortfolioId2 | integer <int32> |
FromDate | string <date-time> Nullable |
ToDate | string <date-time> Nullable |
AggregationLevel | string (AggregationLevel) Enum: "AssetClass" "Sector" "Currency" |
Effect | string (Effect) Enum: "TotalValueAdded" "AssetAllocationEffect" "StockSelectionEffect" "InteractionEffect" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyId": 0,
- "ModelPortfolioId1": 0,
- "ModelPortfolioId2": 0,
- "FromDate": "2024-12-18T16:13:43Z",
- "ToDate": "2024-12-18T16:13:43Z",
- "AggregationLevel": "AssetClass",
- "Effect": "TotalValueAdded"
}
{- "ReferenceCurrency": {
- "Id": 0,
- "UId": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}, - "ModelPortfolio1": {
- "Id": 0,
- "Name": "string"
}, - "ModelPortfolio2": {
- "Id": 0,
- "Name": "string"
}, - "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Effect": 0,
- "CumEffect": 0
}
], - "Error": 0
}
Get the performance attribution of a model portfolio vs. another model portfolio. Note that:
- if a currencyId is not passed then the currency of the system will be taken as the default.<nr />
- if a FromDate / ToDate are not passed then all available data will be returned
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request parameters
CurrencyId | integer <int32> Nullable |
ModelPortfolioId1 | integer <int32> |
ModelPortfolioId2 | integer <int32> |
FromDate | string <date-time> Nullable |
ToDate | string <date-time> Nullable |
AggregationLevel | string (Performance.Abstractions.PerformanceAttribution.GetModelPerformanceAttributionDetails.AggregationLevel) Enum: "AssetClass" "Sector" "Currency" |
Effect | string (Performance.Abstractions.PerformanceAttribution.GetModelPerformanceAttributionDetails.Effect) Enum: "TotalValueAdded" "AssetAllocationEffect" "StockSelectionEffect" "InteractionEffect" |
Mode | string (Mode) Enum: "Details" "Summary" |
ExposureId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyId": 0,
- "ModelPortfolioId1": 0,
- "ModelPortfolioId2": 0,
- "FromDate": "2024-12-18T16:13:43Z",
- "ToDate": "2024-12-18T16:13:43Z",
- "AggregationLevel": "AssetClass",
- "Effect": "TotalValueAdded",
- "Mode": "Details",
- "ExposureId": 0
}
{- "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Items": [
- {
- "ExposureId": 0,
- "ExposureName": "string",
- "AllocationModelPortfolio1": 0,
- "AllocationModelPortfolio2": 0,
- "PerformanceModelPortfolio1": 0,
- "PerformanceModelPortfolio2": 0,
- "IndividualAllocationEffect": 0,
- "IndividualAllocationCumEffect": 0,
- "IndividualSelectionEffect": 0,
- "IndividualSelectionCumEffect": 0,
- "IndividualInteractionEffect": 0,
- "IndividualInteractionCumEffect": 0,
- "IndividualTotalValueAdded": 0,
- "IndividualTotalValueAddedCum": 0
}
]
}
]
}
Calculates and returns the allocations of a passed allocation set.
Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).
If one, or more, of the securities have neither components nor breakdowns, their actual (main) attributes are used instead.
includeLookThrough required | boolean Determines whether security look-through should be accounted for category |
category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" The category for which the allocations should be returned |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request parameters
Allocations | Array of objects (Performance.Abstractions.PerformanceAttribution.CalculatePerformanceAllocations.InstrumentAllocation) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Allocations": [
- {
- "InstrumentId": 5,
- "Allocation": 0.2
}, - {
- "InstrumentId": 8,
- "Allocation": 0.3
}, - {
- "InstrumentId": 153,
- "Allocation": 0.5
}
]
}
{- "PerformanceAllocations": [
- {
- "Category": "AssetClass",
- "Breakdowns": [
- {
- "Id": 1,
- "Allocation": 0.25
}, - {
- "Id": 11,
- "Allocation": 0.25
}, - {
- "Id": 15,
- "Allocation": 0.35
}, - {
- "Id": 39,
- "Allocation": 0.15
}
]
}
]
}
Calculates the returns of the passed allocation according to the provided inputs. Note that if Allocations are passed by the User and their sum is not 100% (but relatively close to 100%), a rounding algorithm is in place to adjust them so that they add up to 100%.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
An object containing: a set of instruments + allocations, number of years used for calculation and the calculation interval
InstrumentSet | object (InstrumentSet) |
Years | integer <int32> Nullable The number of historical years to use for the calculation. If not passed the system default value 'HistoricalPerformanceYears' in group 'Performance' of the Global Settings will be used. |
CalculationInterval | string (AllocationCalculationInterval) Enum: "Monthly" "Yearly" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InstrumentSet": {
- "CurrencyId": 1,
- "Allocations": [
- {
- "InstrumentId": 5,
- "Allocation": 0.25
}, - {
- "InstrumentId": 9,
- "Allocation": 0.75
}
], - "AllocationType": "Percentage"
}, - "Years": 10,
- "CalculationInterval": "Yearly"
}
{- "HistoricalPerformance": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Amount": 0,
- "Value": 0,
- "CashFlow": 0,
- "AdditionalValue": 0
}
], - "RoundingAlgorithmUsed": true,
- "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
Retrieves Person Preferences attributes (e.g. Timezone) in a JSON format. The Preferences refer to a specific Application. Note that the timezone is retrieved always in Windows format.
personId required | integer <int32> The id of the person. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Timezone": "Paraguay Standard Time",
- "CultureInfo": "en-US",
- "DecimalSeparator": ".",
- "ThousandsSeparator": ",",
- "DateFormat": "yyyy-MM-dd",
- "TimeFormat": "HH:mm:ss",
- "AmSymbol": "AM",
- "PmSymbol": "PM",
- "IsAppSpecific": false,
- "Currency": {
- "Id": 1,
- "ThreeLetterIsoCode": "EUR"
}, - "Language": {
- "Id": 1,
- "TwoLetterIsoCode": "en"
}
}
Updates Person Preferences attributes (e.g. Timezone) in a JSON format. Depending on the request values of IsAppSpecific, the Preferences may refer to a specific Application or cross-application. Note that:
switching from application to a cross-application specific settings will clear the application specific settings
irrespective to the operating system, the timezone is always converted and stored in Windows format
personId required | integer <int32> The id of the person. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request body.
Timezone | string Nullable |
CultureInfo | string Nullable |
DecimalSeparator | string Nullable |
ThousandsSeparator | string Nullable |
DateFormat | string Nullable |
TimeFormat | string Nullable |
AmSymbol | string Nullable |
PmSymbol | string Nullable |
CurrencyId | integer <int32> Nullable |
LanguageId | integer <int32> Nullable |
IsAppSpecific | boolean |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Timezone": "Paraguay Standard Time",
- "CultureInfo": "en-US",
- "DecimalSeparator": ".",
- "ThousandsSeparator": ",",
- "DateFormat": "yyyy-MM-dd",
- "TimeFormat": "HH:mm:ss",
- "AmSymbol": "AM",
- "PmSymbol": "PM",
- "CurrencyId": 2,
- "LanguageId": 2,
- "IsAppSpecific": false,
- "UpdateProperties": [
- "Timezone",
- "CultureInfo",
- "DecimalSeparator",
- "ThousandsSeparator",
- "DateFormat",
- "TimeFormat",
- "AmSymbol",
- "PmSymbol",
- "CurrencyId",
- "LanguageId"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes a portfolio proposal by ID.
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
portfolioProposalId required | integer <int32> The ID of the portfolio proposal to retrieve |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes a portfolio account.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to delete the account from |
accountId required | integer <int32> The ID of the account to delete |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes the trading cart of a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to delete the trading cart for |
scope | string (InstrumentTradeTypeScope) Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to delete the trading cart for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets the trading cart of a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to get the trading cart for |
language required | string The language in which to return all properties |
scope | string (InstrumentTradeTypeScope) Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to return the trading cart for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioTradingCart": {
- "Items": [
- {
- "InstrumentId": 1,
- "InstrumentTradeType": "Buy",
- "Amount": 1000
}, - {
- "InstrumentId": 2,
- "InstrumentTradeType": "Buy",
- "Quantity": 50
}, - {
- "InstrumentId": 3,
- "InstrumentTradeType": "Sell",
- "Quantity": 100
}
]
}
}
Modifies the trading cart of a portfolio.
A desired action can be added to the trading cart by defining the details of the trade.
To remove the defined action from the trading cart, the same trade should be passed with an empty (i.e. null) amount / quantity.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to modify the trading cart for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Trades required | Array of objects (InstrumentTrade) The list containing the trades to create/modify |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Trades": [
- {
- "InstrumentId": 1,
- "InstrumentTradeType": "Buy",
- "Amount": 1000
}, - {
- "InstrumentId": 2,
- "InstrumentTradeType": "Buy",
- "Quantity": 50
}, - {
- "InstrumentId": 3,
- "InstrumentTradeType": "Sell",
- "Quantity": 100
}
]
}
{- "Result": "Success"
}
Deletes a model portfolio.
memberId required | integer <int32> The member ID of the RM |
modelPortfolioId required | integer <int32> The ID of the model portfolio to delete |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets a portfolio by ID. Returns all details about a portfolio including KPIs, positions, historical performance and fees. It will also return all goals that are assigned to the portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SecuritiesValue": 770184.89,
- "CashAmount": 1093.01,
- "Fees": [
- {
- "FeeId": 0,
- "FeeType": {
- "Id": 1,
- "Name": "Management"
}, - "FeeRecurrenceType": {
- "Id": 3,
- "Name": "Quarterly"
}, - "IsPercentage": true,
- "FeeValue": 0.2
}, - {
- "FeeId": 0,
- "FeeType": {
- "Id": 2,
- "Name": "Platform"
}, - "FeeRecurrenceType": {
- "Id": 4,
- "Name": "Semesterly"
}, - "IsPercentage": false,
- "FeeValue": 50
}
], - "HistoricalPerformance": [
- {
- "SeriesType": "Portfolio",
- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Amount": 836009.40851,
- "Value": -0.031585056261762556
}, - {
- "Date": "2018-04-25T00:00:00",
- "Amount": 837853.16027,
- "Value": 0.18888727230379487
}, - {
- "Date": "2018-04-26T00:00:00",
- "Amount": 834097.90501,
- "Value": -0.2601590090298256
}
]
}
], - "Positions": [
- {
- "Id": 1,
- "Security": {
- "Id": 4,
- "Name": "VBF EUR DOLPHIN",
- "Isin": "BP0000002018",
- "Type": {
- "Id": 2,
- "Name": "Bond",
- "Description": "Bond"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "AD",
- "Name": "Andorra",
- "Continent": {
- "Id": 1,
- "Name": "Europe"
}
}, - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.4791699068,
- "Quantity": 2282.5839,
- "BuyPrice": 161.91,
- "InvestmentValuePortfolioCurrency": 369573.16,
- "InvestmentValueSecurityCurrency": 369573.16,
- "AccruedInterestPortfolioCurrency": 15076.37,
- "AccruedInterestInstrumentCurrency": 45276.17,
- "ValuationDate": "2018-05-03T00:00:00",
- "ValuationPrice": 161.91,
- "FxRate": 1,
- "Performance": 0.0075,
- "Valuations": [ ]
}, - {
- "Id": 2,
- "Security": {
- "Id": 3,
- "Name": "MICHAEL KORS HOLD",
- "Isin": "VGG607541015",
- "Type": {
- "Id": 3,
- "Name": "Equity",
- "Description": "Equity"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 93,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "HK",
- "Name": "Hong Kong",
- "Continent": {
- "Id": 2,
- "Name": "Asia"
}
}, - "Currency": {
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "US Dollar",
- "CurrencyCode": "USD",
- "Symbol": "$"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.5208301,
- "Quantity": 250,
- "BuyPrice": 66.03,
- "InvestmentValuePortfolioCurrency": 13788.42,
- "InvestmentValueSecurityCurrency": 16507.5,
- "AccruedInterestPortfolioCurrency": 18551.67,
- "AccruedInterestInstrumentCurrency": 96876.23,
- "ValuationDate": "2018-05-03T00:00:00",
- "ValuationPrice": 66.03,
- "FxRate": 1.1972,
- "Performance": 0.0034,
- "Valuations": [ ]
}
], - "HasPendingOrders": false,
- "EsgPreferences": [
- {
- "Id": 0,
- "EsgComponentId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2,
- "MinThreshold": 3,
- "MaxThreshold": 4
}
], - "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "ContactGroupId": 1,
- "Name": "C002747290",
- "Risk": 0.0399,
- "Return": 0.0035,
- "CreateDate": "2018-04-21T00:00:00",
- "ExternalId": "C002747290",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "PortfolioTypeId": 1,
- "PortfolioStatusId": 1,
- "InvestedAmount": 836273.55,
- "FirstInvestmentDate": "2018-04-23T00:00:00",
- "RiskCategory": {
- "Id": 2,
- "Name": "Conservative",
- "Min": 0,
- "Max": 0
}, - "PortfolioRebalancingTypeId": 1,
- "IsActive": true,
- "CurrentValue": 771277.9,
- "CurrentPerformance": 0.0035,
- "CurrentMwrPerformance": 0.43973286,
- "IsReadOnly": false,
- "IsBreached": false,
- "Goals": [
- {
- "Id": 32,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Fly to Mars and back",
- "TargetAmount": 70000,
- "TargetDate": "2032-12-18T14:35:37.5283385+00:00",
- "TemplateId": 10,
- "TemplateName": "Custom",
- "TemplateImage": "Custom.png",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "EURO",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Attributes": "{\"Description\": \"Build the boat that Kostas always wanted to have.\"}"
}
], - "Product": {
- "Fees": [ ],
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "ProductOfferId": 1,
- "Name": "Investment",
- "IsBlockOrderBookEnabled": false,
- "IsOrderBookEnabled": false
}, - "OptimizationConstraintId": 1,
- "CalculatedExpectedReturn": 0.0039,
- "CalculatedRisk": 0.042,
- "SharpeRatio": 0.087,
- "MaximumDrawdown": 0,
- "TimeToRecovery": 0,
- "ValueAtRisk": 0,
- "DownsideVolatility": 0.02,
- "SortinoRatio": 0.0039,
- "CalculationKpis": {
- "FromDate": "2014-09",
- "ToDate": "2024-08",
- "DataPoints": 120
}
}
Gets the basic data and positions of a portfolio by ID. Should mainly be used to retrieve the positions of a portfolio. If additional data is needed 'contacts/{contactId}/portfolios/{portfolioId}' should be used.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "SecuritiesValue": 770184.89,
- "CashAmount": 1093.01,
- "CurrentValue": 771277.9,
- "CurrentPerformance": 0.0035,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Positions": [
- {
- "Id": 1,
- "Security": {
- "Id": 4,
- "Name": "VBF EUR DOLPHIN",
- "Isin": "BP0000002018",
- "Type": {
- "Id": 2,
- "Name": "Bond",
- "Description": "Bond"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "AD",
- "Name": "Andorra",
- "Continent": {
- "Id": 1,
- "Name": "Europe"
}
}, - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.4791699068,
- "Quantity": 2282.5839,
- "BuyPrice": 161.91,
- "InvestmentValuePortfolioCurrency": 369573.16,
- "InvestmentValueSecurityCurrency": 369573.16,
- "AccruedInterestPortfolioCurrency": 18551.67,
- "AccruedInterestInstrumentCurrency": 96876.23,
- "ValuationDate": "2018-05-03T00:00:00",
- "ValuationPrice": 161.91,
- "FxRate": 1,
- "Performance": 0.0075,
- "Valuations": [ ]
}, - {
- "Id": 2,
- "Security": {
- "Id": 3,
- "Name": "MICHAEL KORS HOLD",
- "Isin": "VGG607541015",
- "Type": {
- "Id": 3,
- "Name": "Equity",
- "Description": "Equity"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 93,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "HK",
- "Name": "Hong Kong",
- "Continent": {
- "Id": 2,
- "Name": "Asia"
}
}, - "Currency": {
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "US Dollar",
- "CurrencyCode": "USD",
- "Symbol": "$"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.5208301,
- "Quantity": 250,
- "BuyPrice": 66.03,
- "InvestmentValuePortfolioCurrency": 13788.42,
- "InvestmentValueSecurityCurrency": 16507.5,
- "AccruedInterestPortfolioCurrency": 254751.88,
- "AccruedInterestInstrumentCurrency": 89536.75,
- "ValuationDate": "2018-05-03T00:00:00",
- "ValuationPrice": 66.03,
- "FxRate": 1.1972,
- "Performance": 0.0034,
- "Valuations": [ ]
}
], - "ProductId": 3,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "ParentId": 5,
- "HasPendingOrders": false
}
Gets all portfolios for a specific contact. Returns a list of portfolio summaries (excluding positions and historical performance). The list of portfolios is determined by the contact groups the contact is a member of.
contactId required | integer <int32> The ID of the contact that has access to the portfolios |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "ContactGroupId": 0,
- "Name": "string",
- "Risk": 0,
- "Return": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "ExternalId": "string",
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "PortfolioTypeId": 0,
- "PortfolioStatusId": 0,
- "InvestedAmount": 0,
- "FirstInvestmentDate": "2024-12-18T16:13:43Z",
- "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string",
- "UId": "string"
}, - "PortfolioRebalancingTypeId": 0,
- "ModelPortfolioName": "string",
- "ModelPortfolioId": 0,
- "ModelPortfolioUId": "string",
- "PortfolioProposalName": "string",
- "PortfolioProposalId": 0,
- "CurrentValue": 0,
- "CurrentPerformance": 0,
- "CurrentPerformanceAmount": 0,
- "IsReadOnly": true,
- "IsBreached": true,
- "ParentId": 0,
- "CustomAttributes": "string",
- "Goals": [
- {
- "Id": 0,
- "UId": "string"
}
], - "Product": {
- "Fees": [
- {
- "FeeId": 0,
- "FeeDefinitionId": 0,
- "ValidFrom": "2024-12-18T16:13:43Z",
- "ValidTo": "2024-12-18T16:13:43Z",
- "FeeType": {
- "Id": 0,
- "Name": "string"
}, - "FeeRecurrenceType": {
- "Id": 0,
- "Name": "string"
}, - "IsPercentage": true,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
], - "ProductType": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "UId": "string",
- "ProductOfferId": 0,
- "OfferName": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true
}, - "ChildrenIds": [
- 0
], - "CalculatedExpectedReturn": 0,
- "CalculatedRisk": 0,
- "SharpeRatio": 0,
- "MaximumDrawdown": 0,
- "TimeToRecovery": 0,
- "ValueAtRisk": 0,
- "ProjectedExpectedReturn": 0,
- "DownsideVolatility": 0,
- "SortinoRatio": 0,
- "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
]
Gets all portfolios for a specific contact group. Returns a list of portfolio summaries (excluding positions and historical performance).
contactId required | integer <int32> The ID of the contact that has access to the portfolios |
contactGroupId required | integer <int32> The ID of the contact group that has access to the portfolios |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "ContactGroupId": 0,
- "Name": "string",
- "Risk": 0,
- "Return": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "ExternalId": "string",
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "PortfolioTypeId": 0,
- "PortfolioStatusId": 0,
- "InvestedAmount": 0,
- "FirstInvestmentDate": "2024-12-18T16:13:43Z",
- "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string",
- "UId": "string"
}, - "PortfolioRebalancingTypeId": 0,
- "IsActive": true,
- "ModelPortfolioName": "string",
- "ModelPortfolioId": 0,
- "ModelPortfolioUId": "string",
- "PortfolioProposalName": "string",
- "PortfolioProposalId": 0,
- "CurrentValue": 0,
- "CurrentPerformance": 0,
- "CurrentPerformanceAmount": 0,
- "CurrentMwrPerformance": 0,
- "IsReadOnly": true,
- "IsBreached": true,
- "ParentId": 0,
- "CustomAttributes": "string",
- "Goals": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "TargetAmount": 0,
- "TargetDate": "2024-12-18T16:13:43Z",
- "TemplateId": 0,
- "TemplateName": "string",
- "TemplateImage": "string",
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "Attributes": "string"
}
], - "Product": {
- "Fees": [
- {
- "FeeId": 0,
- "FeeDefinitionId": 0,
- "ValidFrom": "2024-12-18T16:13:43Z",
- "ValidTo": "2024-12-18T16:13:43Z",
- "FeeType": {
- "Id": 0,
- "Name": "string"
}, - "FeeRecurrenceType": {
- "Id": 0,
- "Name": "string"
}, - "IsPercentage": true,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
], - "DefaultOrderBookStatus": {
- "Key": "Reconciliation",
- "Id": 0,
- "Name": "string"
}, - "PortfolioRebalancingType": {
- "Key": "NoRebalancing",
- "Id": 0,
- "Name": "string"
}, - "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}
}
], - "CurrencyConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
}
], - "SecuritySectorConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}
}
], - "SecurityConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Security": {
- "Id": 0,
- "Name": "string",
- "Isin": "string",
- "TradingPrice": 0,
- "FaceValue": 0,
- "ExternalId": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Type": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "BondExtension": {
- "MaturityDate": "2024-12-18T16:13:43Z",
- "BondCouponFrequency": {
- "Key": "Quarterly",
- "Id": 0,
- "Name": "string"
}, - "CouponType": {
- "Key": "Fixed",
- "Id": 0,
- "Name": "string"
}, - "Coupon": 0,
- "InitialSize": 0,
- "IncrementSize": 0,
- "IssueAmount": 0,
- "IssuerType": {
- "Key": "Government",
- "Id": 0,
- "Name": "string"
}, - "IssueDate": "2024-12-18T16:13:43Z"
}, - "OptionExtension": {
- "Strike": 0,
- "IsPut": true,
- "MaturityDate": "2024-12-18T16:13:43Z",
- "OptionExerciseType": {
- "Key": "European",
- "Id": 0,
- "Name": "string"
}
}, - "FutureExtension": {
- "MaturityDate": "2024-12-18T16:13:43Z"
}, - "FundExtension": {
- "SecurityId": 0,
- "InceptionDate": "2024-12-18T16:13:43Z",
- "OfferingFromDate": "2024-12-18T16:13:43Z",
- "OfferingToDate": "2024-12-18T16:13:43Z",
- "Cap": 0,
- "CurrentFill": 0,
- "MinimumInvestmentAmount": 0,
- "MinimumIncrementAmount": 0,
- "FundTypeId": 0,
- "FundManagementTypeId": 0,
- "FundInvestmentTypeId": 0,
- "FundType": {
- "Key": "MutualFund",
- "Id": 0,
- "Name": "string"
}, - "FundManagementType": {
- "Key": "Passive",
- "Id": 0,
- "Name": "string"
}, - "FundInvestmentType": {
- "Key": "OpenEnd",
- "Id": 0,
- "Name": "string"
}
}, - "Ratings": [
- {
- "Id": 0,
- "Value": "string",
- "Color": "string",
- "Agency": {
- "Id": 0,
- "Name": "string",
- "Description": "string"
}
}
], - "Focus": {
- "Id": 0,
- "Name": "string",
- "Parent": { }
}, - "SecurityStockExchanges": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "Ticker": "string",
- "IsDefault": true,
- "SecurityStockExchangeId": "string",
- "PriceFeedIntegrationIdentifier": "string",
- "PriceFeedIntegrationIdentifierType": "string",
- "StockExchange": {
- "Id": 0,
- "MarketCode": "string",
- "Description": "string",
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
}
], - "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": true,
- "CustomAttributes": "string",
- "TradingUnit": 0,
- "RoundingLot": 0,
- "BenchmarkId": 0,
- "Factor": 0,
- "IsPricePercentage": true,
- "LogoUrl": "string",
- "UId": "string"
}
}
], - "SecurityTypeConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "SecurityType": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}
}
], - "ContinentConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
], - "EconomicalZoneConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
], - "CountryConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
]
}, - "Id": 0,
- "UId": "string",
- "ProductOfferId": 0,
- "OfferName": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true
}, - "OptimizationConstraintId": 0,
- "BenchmarkId": 0,
- "CalculatedExpectedReturn": 0,
- "CalculatedRisk": 0,
- "SharpeRatio": 0,
- "MaximumDrawdown": 0,
- "TimeToRecovery": 0,
- "ValueAtRisk": 0,
- "ProjectedExpectedReturn": 0,
- "DownsideVolatility": 0,
- "SortinoRatio": 0,
- "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}
]
Gets all model portfolios associated with the risk categories of a product. The endpoint returns:
productId required | integer <int32> The ID of the product that the model portfolios belong to |
language required | string The language in which to return all properties |
riskCategoryId | integer <int32> The optional risk category ID to return only model portfolios of this risk category |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "SelectionCriteria": "string",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Picture": "string",
- "Attributes": "string",
- "IsActive": true,
- "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string",
- "UId": "string"
}, - "ExternalId": "string"
}
]
Gets a model portfolio not assigned to a Member by ID.
Returns all details about a model portfolio including KPIs, positions and fees.
modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve |
language required | string The language in which to return all properties |
currencyId | integer <int32> The ID of the currency to use for KPI calculation |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CustomExpectedRisk": 0.047,
- "CustomExpectedReturn": 0.0042,
- "CalculatedRisk": 0.042,
- "CalculatedExpectedReturn": 0.0039,
- "SharpeRatio": 0.087,
- "Positions": [
- {
- "Security": {
- "Id": 4,
- "Name": "VBF EUR DOLPHIN",
- "Isin": "BP0000002018",
- "Type": {
- "Id": 2,
- "Name": "Bond",
- "Description": "Bond"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "AD",
- "Name": "Andorra",
- "Continent": {
- "Id": 1,
- "Name": "Europe"
}
}, - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.4791699068
}, - {
- "Security": {
- "Id": 3,
- "Name": "MICHAEL KORS HOLD",
- "Isin": "VGG607541015",
- "Type": {
- "Id": 3,
- "Name": "Equity",
- "Description": "Equity"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 93,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "HK",
- "Name": "Hong Kong",
- "Continent": {
- "Id": 2,
- "Name": "Asia"
}
}, - "Currency": {
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "US Dollar",
- "CurrencyCode": "USD",
- "Symbol": "$"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.5208301
}
], - "Fees": [
- {
- "FeeId": 0,
- "FeeType": {
- "Id": 1,
- "Name": "Management"
}, - "FeeRecurrenceType": {
- "Id": 3,
- "Name": "Quarterly"
}, - "IsPercentage": true,
- "FeeValue": 0.2
}, - {
- "FeeId": 0,
- "FeeType": {
- "Id": 2,
- "Name": "Platform"
}, - "FeeRecurrenceType": {
- "Id": 4,
- "Name": "Semesterly"
}, - "IsPercentage": false,
- "FeeValue": 50
}
], - "BaseCurrency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "IsEditable": false,
- "MaximumDrawdown": 0,
- "TimeToRecovery": 0,
- "ValueAtRisk": 0,
- "DownsideVolatility": 0.02,
- "SortinoRatio": 0.0039,
- "CalculationKpis": {
- "FromDate": "2014-09",
- "ToDate": "2024-08",
- "DataPoints": 120
}, - "AllocationType": {
- "Key": "SaaModel",
- "Id": 1,
- "Name": "SAA Model"
}, - "DerivedFromModelPortfolioId": 1,
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "C002747290",
- "IsActive": true,
- "RiskCategory": {
- "Id": 2,
- "Name": "Conservative",
- "Min": 0,
- "Max": 0
}, - "ExternalId": "TEST1"
}
Gets the details of a model portfolio assigned to a Member by ID.
Returns all details about a model portfolio including KPIs, positions and fees.
memberId required | integer <int32> The member ID of the RM |
modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve |
language required | string The language in which to return all properties |
currencyId | integer <int32> The ID of the currency to use for KPI calculation |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CustomExpectedRisk": 0.047,
- "CustomExpectedReturn": 0.0042,
- "CalculatedRisk": 0.042,
- "CalculatedExpectedReturn": 0.0039,
- "SharpeRatio": 0.087,
- "Positions": [
- {
- "Security": {
- "Id": 4,
- "Name": "VBF EUR DOLPHIN",
- "Isin": "BP0000002018",
- "Type": {
- "Id": 2,
- "Name": "Bond",
- "Description": "Bond"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "AD",
- "Name": "Andorra",
- "Continent": {
- "Id": 1,
- "Name": "Europe"
}
}, - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.4791699068
}, - {
- "Security": {
- "Id": 3,
- "Name": "MICHAEL KORS HOLD",
- "Isin": "VGG607541015",
- "Type": {
- "Id": 3,
- "Name": "Equity",
- "Description": "Equity"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 93,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "HK",
- "Name": "Hong Kong",
- "Continent": {
- "Id": 2,
- "Name": "Asia"
}
}, - "Currency": {
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "US Dollar",
- "CurrencyCode": "USD",
- "Symbol": "$"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.5208301
}
], - "Fees": [
- {
- "FeeId": 0,
- "FeeType": {
- "Id": 1,
- "Name": "Management"
}, - "FeeRecurrenceType": {
- "Id": 3,
- "Name": "Quarterly"
}, - "IsPercentage": true,
- "FeeValue": 0.2
}, - {
- "FeeId": 0,
- "FeeType": {
- "Id": 2,
- "Name": "Platform"
}, - "FeeRecurrenceType": {
- "Id": 4,
- "Name": "Semesterly"
}, - "IsPercentage": false,
- "FeeValue": 50
}
], - "BaseCurrency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "IsEditable": false,
- "MaximumDrawdown": 0,
- "TimeToRecovery": 0,
- "ValueAtRisk": 0,
- "DownsideVolatility": 0.02,
- "SortinoRatio": 0.0039,
- "CalculationKpis": {
- "FromDate": "2014-09",
- "ToDate": "2024-08",
- "DataPoints": 120
}, - "AllocationType": {
- "Key": "SaaModel",
- "Id": 1,
- "Name": "SAA Model"
}, - "DerivedFromModelPortfolioId": 1,
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "C002747290",
- "IsActive": true,
- "RiskCategory": {
- "Id": 2,
- "Name": "Conservative",
- "Min": 0,
- "Max": 0
}, - "ExternalId": "TEST1"
}
Gets the constraints of a model portfolio not assigned to a Member by ID.
modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve optimization constraints for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Gets the constraints of a model portfolio assigned to a Member by ID.
memberId required | integer <int32> The member ID of the RM |
modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve optimization constraints for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Gets the investment overview for a specific contact or of a specific contact group that the contact is a part of.
The investment overview contains a list of portfolio summaries of real portfolios and portfolio proposals as well as data aggregated from all real portfolios including a list of positions, the historical and current performance, current total amounts of securities and cash.
It also contains the base currency that all aggregated values have been converted to.
contactId required | integer <int32> The ID of the contact to get the investment overview for |
language required | string The language in which to return all properties |
currencyId | integer <int32> The ID of the currency to use as base currency and for KPI and historical performance calculation |
contactGroupId | integer <int32> The ID of the contact group that has access to the portfolio |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrentValue": 19635964.0421,
- "SecuritiesValue": 19608137.0219,
- "CashAmount": 27826.94159,
- "CurrentPerformance": 0.35339202826882854,
- "CurrentPerformanceAmount": 839230.61183,
- "CurrentMwrPerformance": 0.43973286,
- "BaseCurrency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "ConsolidatedPositions": [
- {
- "SecurityId": 4,
- "Allocation": 70,
- "InvestmentValue": 19535964.0421
}, - {
- "SecurityId": 3,
- "Allocation": 30,
- "InvestmentValue": 100000
}
]
}
Gets the constraints of a portfolio by ID.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve optimization constraints for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Gets a portfolio proposal by ID. Returns all details about the proposal including KPIs, positions and historical performance.
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
portfolioProposalId required | integer <int32> The ID of the portfolio proposal to retrieve |
language required | string The language in which to return all properties |
currencyId | integer <int32> The ID of the currency to use for KPI and historical performance calculation |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CalculatedRisk": 0.042,
- "CalculatedExpectedReturn": 0.0039,
- "SharpeRatio": 0.087,
- "DownsideVolatility": 0.02,
- "SortinoRatio": 0.0039,
- "HistoricalPerformance": [
- {
- "SeriesType": "Portfolio",
- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Amount": 836009.40851,
- "Value": -0.031585056261762556
}, - {
- "Date": "2018-04-25T00:00:00",
- "Amount": 837853.16027,
- "Value": 0.18888727230379487
}, - {
- "Date": "2018-04-26T00:00:00",
- "Amount": 834097.90501,
- "Value": -0.2601590090298256
}
]
}
], - "Positions": [
- {
- "Security": {
- "Id": 4,
- "Name": "VBF EUR DOLPHIN",
- "Isin": "BP0000002018",
- "Type": {
- "Id": 2,
- "Name": "Bond",
- "Description": "Bond"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "AD",
- "Name": "Andorra",
- "Continent": {
- "Id": 1,
- "Name": "Europe"
}
}, - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.4791699068,
- "IsNotAdvised": false
}, - {
- "Security": {
- "Id": 3,
- "Name": "MICHAEL KORS HOLD",
- "Isin": "VGG607541015",
- "Type": {
- "Id": 3,
- "Name": "Equity",
- "Description": "Equity"
}, - "Sector": {
- "Id": 20,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Energy",
- "Description": "",
- "IsActive": false
}, - "Country": {
- "Id": 93,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CountryCode": "HK",
- "Name": "Hong Kong",
- "Continent": {
- "Id": 2,
- "Name": "Asia"
}
}, - "Currency": {
- "Id": 3,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "US Dollar",
- "CurrencyCode": "USD",
- "Symbol": "$"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": false,
- "IsActive": false,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false,
- "UId": "357907ea-bc5c-4b7e-9991-aa186476c513"
}, - "Allocation": 0.5208301,
- "IsNotAdvised": false
}
], - "CalculationKpis": {
- "FromDate": "2014-09",
- "ToDate": "2024-08",
- "DataPoints": 120
}, - "Id": 1,
- "Name": "C002747290",
- "CustomExpectedRisk": 0.038,
- "CustomExpectedReturn": 0.0035,
- "PortfolioProposalStatusId": 1,
- "CreateDate": "2018-04-21T00:00:00",
- "ProductId": 1,
- "CurrencyId": 0
}
Gets the constraints of a portfolio proposal by ID.
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
portfolioProposalId required | integer <int32> The ID of the portfolio proposal to retrieve optimization constraints for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "Id": 0,
- "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Gets all portfolio proposals for a specific contact. Returns a list of portfolio proposal summaries (excluding positions and historical performance). The list of portfolio proposals is determined by the contact groups the contact is a member of.
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposals |
portfolioId | integer <int32> Optional ID of the Portfolio |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "Name": "string",
- "CustomExpectedRisk": 0,
- "CustomExpectedReturn": 0,
- "PortfolioProposalStatusId": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "ProductId": 0,
- "ProductUId": "string",
- "RecommendedAmount": 0,
- "BenchmarkId": 0,
- "BenchmarkUId": "string",
- "BenchmarkName": "string",
- "ModelPortfolioId": 0,
- "ModelPortfolioUId": "string",
- "PortfolioId": 0,
- "PortfolioUId": "string",
- "RelationshipManagerId": 0,
- "CurrencyId": 0,
- "CurrencyUId": "string"
}
]
Gets the accounts related to a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve the transactions for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Account": {
- "Id": 0,
- "UId": "string",
- "AccountNumber": "string",
- "Iban": "string",
- "InternalId": "string",
- "Name": "string",
- "Balance": 0,
- "BalanceLastUpdateDate": "2024-12-18T16:13:43Z",
- "BranchId": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "ContactGroupId": 0,
- "Type": {
- "Id": 0,
- "Name": "string",
- "InternalId": "string"
}, - "IsActive": true,
- "ParentId": 0,
- "OpeningDate": "2024-12-18T16:13:43Z",
- "Product": {
- "Id": 0,
- "UId": "string",
- "ProductOfferId": 0,
- "OfferName": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true
}, - "Status": {
- "Id": 0,
- "Name": "string"
}, - "ClosingDate": "2024-12-18T16:13:43Z",
- "IntegrationStatus": {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string"
}, - "Attributes": "string",
- "SubAccounts": [
- 0
], - "AvailableBalance": 0,
- "AvailableBalanceLastUpdateDate": "2024-12-18T16:13:43Z"
}, - "IsDefaultCustodyAccount": true,
- "IsPayoutAccount": true,
- "IsPayinAccount": true
}
]
Links accounts to a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to create the account for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
AccountId | integer <int32> |
IsDefaultCustodyAccount | boolean |
IsPayoutAccount | boolean |
IsPayinAccount | boolean Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AccountId": 34,
- "IsDefaultCustodyAccount": true,
- "IsPayoutAccount": false,
- "IsPayinAccount": false
}
{- "Account": {
- "Id": 34,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Iban": "00250507603002747290",
- "InternalId": "603002747290",
- "Name": "00250507603002747290",
- "BranchId": 0,
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "ContactGroupId": 0,
- "Type": {
- "Id": 2,
- "Name": "Securities"
}, - "IsActive": false,
- "Product": {
- "Fees": [ ],
- "Id": 1,
- "UId": "00000000-0000-0000-0000-000000000000",
- "ProductOfferId": 1,
- "Name": "Execution only",
- "IsBlockOrderBookEnabled": false,
- "IsOrderBookEnabled": false
}, - "Status": {
- "Id": 1,
- "Name": "Active"
}, - "Attributes": "{\"Description\": \"Account opened by Mr. X for the purposes of Y.\"}"
}, - "IsDefaultCustodyAccount": true,
- "IsPayoutAccount": false,
- "IsPayinAccount": false
}
Gets the changes of a portfolio within an optional date range.
All currency values are returned in the base currency of the portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve the changes for |
page required | integer <int32> The result page number, starting by 1 |
pageSize required | integer <int32> The number of items in a result page |
language required | string The language in which to return all properties |
from | string <date-time> An optional start date for returning only changes with this date or newer |
to | string <date-time> An optional end date for returning only changes with this date or older |
changeStatusId | string (PortfolioChangeStatusId) Enum: "ToBeProcessed" "Processed" "Canceled" "Failed" An optional change status to filter the portfolio changes for this value. Default value is null. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Changes": [
- {
- "Id": 61,
- "PortfolioId": 1,
- "ModelPortfolioId": 7,
- "CreateDate": "0001-01-01T00:00:00",
- "RiskCategory": {
- "Id": 2,
- "Name": "Conservative"
}, - "PortfolioChangeType": {
- "Key": "Reduction",
- "Id": 4,
- "Name": "Reduction"
}, - "Details": [
- {
- "Id": 92,
- "Allocation": 0,
- "Amount": 100,
- "Status": {
- "Key": "Processed",
- "Id": 2,
- "Name": "Processed"
}
}
]
}, - {
- "Id": 62,
- "PortfolioId": 1,
- "ModelPortfolioId": 7,
- "CreateDate": "0001-01-01T00:00:00",
- "RiskCategory": {
- "Id": 2,
- "Name": "Conservative"
}, - "PortfolioChangeType": {
- "Key": "Reduction",
- "Id": 4,
- "Name": "Rebalancing"
}, - "Details": [
- {
- "Id": 95,
- "Allocation": 0.5,
- "Amount": 0,
- "Security": {
- "Id": 20,
- "Name": "DEUTSCHE TELEKOM",
- "Isin": "DE0005557508",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Processed",
- "Id": 2,
- "Name": "Processed"
}
}, - {
- "Id": 95,
- "Allocation": 0.5,
- "Amount": 0,
- "Security": {
- "Id": 94,
- "Name": "AIRBUS GROUP",
- "Isin": "NL0000235190",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Processed",
- "Id": 2,
- "Name": "Processed"
}
}
]
}
], - "TotalNumberOfResults": 2
}
Gets the order book entries of a portfolio within an optional date range.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve the changes for |
page required | integer <int32> The result page number, starting by 1 |
pageSize required | integer <int32> The number of items in a result page |
language required | string The language in which to return all properties |
from | string <date-time> An optional start date for returning only order book entries with this date or newer |
to | string <date-time> An optional end date for returning only order book entries with this date or older |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OrderBookEntries": [
- {
- "Id": 106,
- "PortfolioChangeId": 61,
- "Quantity": 1249.883143325161,
- "Price": 12.34,
- "AmountAccountCurrency": 13497.15559585229,
- "AmountSecurityCurrency": 15423.557988632487,
- "CreateDate": "2024-12-18T14:35:37.6244517Z",
- "PortfolioId": 1,
- "PortfolioUId": "00000000-0000-0000-0000-000000000000",
- "ProductId": 1,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "ProductName": "Execution Only",
- "Security": {
- "Id": 20,
- "Name": "DEUTSCHE TELEKOM",
- "Isin": "DE0005557508",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Reconciliation",
- "Id": 1,
- "Name": "Reconciliation"
}, - "StockExchangeOrderType": {
- "Key": "Market",
- "Id": 1,
- "Name": "Market"
}, - "OrderValidity": {
- "Key": "GoodTillDate",
- "Id": 1,
- "Name": "GoodTilDate"
}, - "CustodyAccount": {
- "Id": 34,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Iban": "00250507603002747290",
- "InternalId": "603002747290",
- "Name": "00250507603002747290",
- "Balance": 200000,
- "BranchId": 0,
- "ContactGroupId": 0,
- "Type": {
- "Id": 2,
- "Name": "Custody"
}, - "IsActive": false
}, - "Notes": [ ],
- "FxRate": 0,
- "OriginalQuantity": 0,
- "ExternalId": "Ext123"
}, - {
- "Id": 103,
- "PortfolioChangeId": 61,
- "Quantity": -250,
- "Price": 15.315,
- "AmountAccountCurrency": -12066.246342,
- "AmountSecurityCurrency": -16507.5,
- "CreateDate": "2024-12-18T14:35:37.6244561Z",
- "PortfolioId": 1,
- "PortfolioUId": "00000000-0000-0000-0000-000000000000",
- "ProductId": 1,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "ProductName": "Execution Only",
- "Security": {
- "Id": 94,
- "Name": "AIRBUS GROUP",
- "Isin": "NL0000235190",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Reconciliation",
- "Id": 1,
- "Name": "Reconciliation"
}, - "StockExchangeOrderType": {
- "Key": "Market",
- "Id": 1,
- "Name": "Market"
}, - "OrderValidity": {
- "Key": "GoodTillDate",
- "Id": 1,
- "Name": "GoodTilDate"
}, - "CustodyAccount": {
- "Id": 34,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Iban": "00250507603002747290",
- "InternalId": "603002747290",
- "Name": "00250507603002747290",
- "Balance": 200000,
- "BranchId": 0,
- "ContactGroupId": 0,
- "Type": {
- "Id": 2,
- "Name": "Custody"
}, - "IsActive": false
}, - "Notes": [ ],
- "FxRate": 0,
- "OriginalQuantity": 0,
- "ExternalId": "Ext234"
}
], - "TotalNumberOfResults": 2
}
Searches the order book entries of a portfolio by provided criteria
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve the changes for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search criteria
PortfolioChangeIds | Array of integers <int32> Nullable |
SecurityIds | Array of integers <int32> Nullable |
StockExchangeIds | Array of integers <int32> Nullable |
StockExchangeOrderTypeIds | Array of integers <int32> Nullable |
StockExchangeOrderValidityIds | Array of integers <int32> Nullable |
OrderBookStatusIds | Array of integers <int32> Nullable |
OrderTypeIds | Array of integers <int32> Nullable |
BlockOrderIds | Array of integers <int32> Nullable |
OrderBookIntegrationStatusIds | Array of integers <int32> Nullable |
TradingCurrencyIds | Array of integers <int32> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
ReleaseDateFrom | string <date-time> Nullable |
ReleaseDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioChangeIds": [
- 0
], - "SecurityIds": [
- 0
], - "StockExchangeIds": [
- 0
], - "StockExchangeOrderTypeIds": [
- 0
], - "StockExchangeOrderValidityIds": [
- 0
], - "OrderBookStatusIds": [
- 0
], - "OrderTypeIds": [
- 0
], - "BlockOrderIds": [
- 0
], - "OrderBookIntegrationStatusIds": [
- 0
], - "TradingCurrencyIds": [
- 0
], - "CreateDateFrom": "2024-12-18T16:13:43Z",
- "CreateDateTo": "2024-12-18T16:13:43Z",
- "ReleaseDateFrom": "2024-12-18T16:13:43Z",
- "ReleaseDateTo": "2024-12-18T16:13:43Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "PortfolioChangeId": 0,
- "Quantity": 0,
- "Price": 0,
- "LimitPrice": 0,
- "StopPrice": 0,
- "AmountAccountCurrency": 0,
- "AmountSecurityCurrency": 0,
- "ValidityDate": "2024-12-18T16:13:43Z",
- "CreateDate": "2024-12-18T16:13:43Z",
- "ReleaseDate": "2024-12-18T16:13:43Z",
- "PortfolioId": 0,
- "PortfolioUid": "string",
- "ProductId": 0,
- "ProductUid": "string",
- "SecurityId": 0,
- "OrderBookStatusId": 0,
- "OrderBookIntegrationStatusId": 0,
- "StockExchangeOrderTypeId": 0,
- "StockExchangeOrderValidityId": 0,
- "CustodyAccountId": 0,
- "FundingAccountId": 0,
- "OrderTypeId": 0,
- "FxRate": 0,
- "OriginalQuantity": 0,
- "BlockOrderId": 0,
- "StockExchangeId": 0,
- "TradingCurrencyId": 0,
- "AccountTransactionId": 0,
- "CustodyParticipantUid": "string",
- "CounterpartyParticipantUid": "string",
- "ExternalId": "string"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Returns the performance time series of a portfolio for a given date range and the currency information used for calculation. If no date is passed it returns the whole time series since inception.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio for which the performance will be calculated |
from | string <date-time> An optional date which represents the start date of the interval for the calculated performance time series |
to | string <date-time> An optional date which represents the end date of the interval for the calculated performance time series |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Amount": 836009.40851,
- "Value": -0.031585056261762556,
- "CashFlow": 836009.40851
}, - {
- "Date": "2018-04-25T00:00:00",
- "Amount": 837853.16027,
- "Value": 0.18888727230379487,
- "CashFlow": 0
}, - {
- "Date": "2018-04-26T00:00:00",
- "Amount": 834097.90501,
- "Value": -0.2601590090298256,
- "CashFlow": 0
}
], - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}
}
Returns the performance time series of all portfolios that belongs to a contact or of a contact group that the contact is a part of, for a given date range and the currency information used for calculation.
contactId required | integer <int32> The ID of the contact |
currencyId | integer <int32> The ID of the currency to use as base currency for performance calculation |
from | string <date-time> An optional date which represents the start date of the interval for the calculated performance time series |
to | string <date-time> An optional date which represents the end date of the interval for the calculated performance time series |
contactGroupId | integer <int32> The Id of a contact group that the contact is a part of. This will filter even more the results by only displaying the performance of that contact group, as oppose to displaying the performance of a contact, which may be a part of multiple contact groups. |
portfolioStatus | string (PortfolioStatusFilterKey) Enum: "All" "Implemented" "Blocked" "Closed" An optional input allowing the user to define which portfolios should be aggregated together based on their current status. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Amount": 836009.40851,
- "Value": -0.031585056261762556,
- "CashFlow": 836009.40851
}, - {
- "Date": "2018-04-25T00:00:00",
- "Amount": 837853.16027,
- "Value": 0.18888727230379487,
- "CashFlow": 0
}, - {
- "Date": "2018-04-26T00:00:00",
- "Amount": 834097.90501,
- "Value": -0.2601590090298256,
- "CashFlow": 0
}
], - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}
}
Returns the monetary performance time series of a portfolio for a given date range and the currency information used for calculation.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio for which the monetary performance will be retrieved |
from | string <date-time> An optional date which represents the start date of the interval for the monetary performance time series |
to | string <date-time> An optional date which represents the end date of the interval for the monetary performance time series |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Value": 659.52
}, - {
- "Date": "2018-04-25T00:00:00",
- "Value": -158.78
}, - {
- "Date": "2018-04-26T00:00:00",
- "Value": 300
}
], - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}
}
Returns the daily monetary performance time series of all portfolios for a given contact or of a respective contact group that the contact is a part of, and a given date range and the currency information used for calculation.
contactId required | integer <int32> The ID of the contact that has access to the portfolios |
currencyId | integer <int32> The ID of the currency to use as base currency for performance calculation |
from | string <date-time> An optional date which represents the start date of the interval for the monetary performance time series |
to | string <date-time> An optional date which represents the end date of the interval for the monetary performance time series |
contactGroupId | integer <int32> The Id of a contact group that the contact is a part of. This will filter even more the results by only displaying the performance of that contact group, as oppose to displaying the performance of a contact, which may be a part of multiple contact groups. |
portfolioStatus | string (PortfolioStatusFilterKey) Enum: "All" "Implemented" "Blocked" "Closed" An optional input allowing the user to define which portfolios should be aggregated together based on their current status. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Values": [
- {
- "Date": "2018-04-24T00:00:00",
- "Value": 659.52
}, - {
- "Date": "2018-04-25T00:00:00",
- "Value": -158.78
}, - {
- "Date": "2018-04-26T00:00:00",
- "Value": 300
}
], - "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}
}
Gets model portfolios associated to a member hierarchy.
memberId required | integer <int32> The member ID of the RM |
language required | string The language in which to return all properties |
riskCategoryId | integer <int32> The optional risk category ID to return only model portfolios of this risk category |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "MinInvestment": 0,
- "MaxInvestment": 0,
- "ExpectedRisk": 0,
- "ExpectedReturn": 0,
- "TimeHorizon": 0,
- "RelationshipManagerId": 0,
- "RiskCategoryId": 0,
- "RiskCategoryDefinitionId": 0,
- "OptimizationTypeId": 0,
- "TypeId": 0,
- "BenchmarkId": 0,
- "BenchmarkUId": "string",
- "IsActive": true,
- "IsEditable": true,
- "CustomAttributes": "string",
- "AllocationType": {
- "Key": "SaaModel",
- "Id": 0,
- "Name": "string"
}, - "DerivedFromModelPortfolioId": 0,
- "ExternalId": "string"
}
]
Gets balance information for each product of a contact. Returns the current balance as well as the balance history and the allocation percentage. All balance information is returned in the base currency (returned in the Currency property) Only balance information from active accounts is returned.
contactId required | integer <int32> |
language required | string |
calculationInterval | string (CalculationInterval) Enum: "Daily" "Weekly" "Monthly" "Yearly" |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Total": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "Products": [
- {
- "ProductId": 0,
- "ProductUId": "string",
- "ProductName": "string",
- "Balance": 0,
- "Allocation": 0,
- "BalanceHistory": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Balance": 0
}
]
}
]
}
Gets the switch suggestion details.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio associated with the suggestion basket |
switchSuggestionId required | integer <int32> The ID of the suggestion basket |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "UId": "fb7f9a14-e0cd-4797-8d08-efda8e069fea",
- "InteractionId": 128,
- "MemberId": 23,
- "CreateDate": "2021-01-18T12:00:03",
- "ValidTill": "2021-02-20T11:59:07",
- "Switches": [
- {
- "From": {
- "BasketDetailId": 12,
- "SecurityId": 5,
- "Allocation": 0.5
}, - "To": [
- {
- "BasketDetailId": 13,
- "SecurityId": 6,
- "Allocation": 0.25
}, - {
- "BasketDetailId": 14,
- "SecurityId": 7,
- "Allocation": 0.75
}
]
}, - {
- "From": {
- "BasketDetailId": 15,
- "SecurityId": 6,
- "Allocation": 0.5
}, - "To": [
- {
- "BasketDetailId": 16,
- "SecurityId": 23,
- "Allocation": 0.65
}, - {
- "BasketDetailId": 17,
- "SecurityId": 112,
- "Allocation": 0.35
}
]
}
]
}
Accepts or rejects a switch suggestion.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio associated with the suggestion basket |
switchSuggestionId required | integer <int32> The ID of the suggestion basket |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
IsAccepted | boolean Determines whether the switch suggestion should be accepted or rejected. |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "IsAccepted": true,
- "ForceOrderGeneration": false
}
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Gets the switch suggestions details.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio associated with the suggestion baskets |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 13,
- "UId": "fb7f9a14-e0cd-4797-8d08-efda8e069fea",
- "InteractionId": 128,
- "MemberId": 23,
- "CreateDate": "2021-01-18T12:00:03",
- "ValidTill": "2021-02-20T11:59:07",
- "Switches": [
- {
- "From": {
- "BasketDetailId": 12,
- "SecurityId": 5,
- "Allocation": 0.5
}, - "To": [
- {
- "BasketDetailId": 13,
- "SecurityId": 6,
- "Allocation": 0.25
}, - {
- "BasketDetailId": 14,
- "SecurityId": 7,
- "Allocation": 0.75
}
]
}, - {
- "From": {
- "BasketDetailId": 15,
- "SecurityId": 6,
- "Allocation": 0.5
}, - "To": [
- {
- "BasketDetailId": 16,
- "SecurityId": 23,
- "Allocation": 0.65
}, - {
- "BasketDetailId": 17,
- "SecurityId": 112,
- "Allocation": 0.35
}
]
}
]
}, - {
- "Id": 14,
- "UId": "0b9a5030-3b7f-4b5b-8e2d-1e684085de1f",
- "MemberId": 23,
- "CreateDate": "2021-01-18T12:00:12",
- "ValidTill": "2022-02-20T11:59:07",
- "Switches": [
- {
- "From": {
- "BasketDetailId": 12,
- "SecurityId": 5,
- "Allocation": 0.5
}, - "To": [
- {
- "BasketDetailId": 13,
- "SecurityId": 6,
- "Allocation": 0.25
}, - {
- "BasketDetailId": 14,
- "SecurityId": 7,
- "Allocation": 0.75
}
]
}, - {
- "From": {
- "BasketDetailId": 15,
- "SecurityId": 6,
- "Allocation": 0.5
}, - "To": [
- {
- "BasketDetailId": 16,
- "SecurityId": 23,
- "Allocation": 0.65
}, - {
- "BasketDetailId": 17,
- "SecurityId": 112,
- "Allocation": 0.35
}
]
}
]
}
]
Returns a re-evaluation of the portfolio according to the latest security and currency prices available to it.
Note this is an estimate made using the latest positions of the portfolio available to the application (i.e. as per data present in PortfolioContent).
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio that will be reevaluated |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SecuritiesValue": 0,
- "CashAmount": 0,
- "Positions": [
- {
- "Id": 0,
- "Security": {
- "Id": 0,
- "UId": "string"
}, - "AccountId": 0,
- "Allocation": 0,
- "Quantity": 0,
- "InvestmentValuePortfolioCurrency": 0,
- "InvestmentValueSecurityCurrency": 0,
- "ValuationPrice": 0,
- "FxRate": 0
}
]
}
Returns the performance time series of a security in a portfolio for a given date range and the currency information used for calculation. If no date is passed it returns the whole time series since inception.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio |
securityId required | integer <int32> The ID of the security |
from | string <date-time> An optional date which represents the start date of the interval for the calculated performance time series |
to | string <date-time> An optional date which represents the end date of the interval for the calculated performance time series |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Performance": [
- {
- "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Amount": 0,
- "CashFlow": 0,
- "DailyPerf": 0,
- "CumulativePerf": 0
}
], - "AccountId": 0
}
], - "Currency": {
- "Id": 0,
- "UId": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
}
Returns the monetary performance time series of a security in a portfolio for a given date range and the currency information used for calculation. If no date is passed it returns the whole time series since inception.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio |
securityId required | integer <int32> The ID of the security |
from | string <date-time> An optional date which represents the start date of the interval for the calculated performance time series |
to | string <date-time> An optional date which represents the end date of the interval for the calculated performance time series |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Performance": [
- {
- "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "DailyPerf": 0,
- "CumulativePerf": 0
}
], - "AccountId": 0
}
], - "Currency": {
- "Id": 0,
- "UId": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
}
Calculates and returns the allocations of a passed portfolio proposal.
Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).
If one, or more, of the securities have neither components nor breakdowns, their actual (main) attributes are used instead.
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
portfolioProposalId required | integer <int32> The ID of the portfolio proposal to retrieve |
includeLookThrough required | boolean Determines whether security look-through should be accounted for category |
category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" The category for which the allocations should be returned |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioProposalAllocations": [
- {
- "Category": "AssetClass",
- "Breakdowns": [
- {
- "Id": 0,
- "Allocation": 0
}
]
}
]
}
Calculates and returns the allocations of a passed model portfolio that is assigned, or not, to a Member.
Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).
If one, or more, of the securities have neither components nor breakdowns, their actual (main) attributes are used instead.
memberId required | integer <int32> The member ID of the RM |
modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve |
includeLookThrough required | boolean Determines whether security look-through should be accounted for category |
category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" The category for which the allocations should be returned |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ModelPortfolioAllocations": [
- {
- "Category": "AssetClass",
- "Breakdowns": [
- {
- "Id": 0,
- "Allocation": 0
}
]
}
]
}
Calculates and returns the allocations of a passed model portfolio that is not assigned to a Member.
Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).
If one, or more, of the securities have neither components nor breakdowns, their actual (main) attributes are used instead.
modelPortfolioId required | integer <int32> The ID of the model portfolio to retrieve |
includeLookThrough required | boolean Determines whether security look-through should be accounted for category |
category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" The category for which the allocations should be returned |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ModelPortfolioAllocations": [
- {
- "Category": "AssetClass",
- "Breakdowns": [
- {
- "Id": 0,
- "Allocation": 0
}
]
}
]
}
Calculates and returns the allocations of a passed contact of a specific contact group that the contact is a part of.
Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).
If one, or more, of the securities have neither components nor breakdowns, their actual (main) attributes are used instead.
contactId required | integer <int32> The ID of the contact to get the allocations for |
includeLookThrough required | boolean Determines whether security look-through should be accounted for category |
category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" The category for which the allocations should be returned |
language required | string The language in which to return currency name |
currencyId | integer <int32> The ID of the currency to use as base currency |
contactGroupId | integer <int32> The Id of a contact group that the contact is a part of. This will filter even more the results by only displaying the allocations of that contact group, as oppose to displaying the allocation of a contact, which may be a part of multiple contact groups. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Allocations": [
- {
- "Category": "AssetClass",
- "Breakdowns": [
- {
- "Amount": 0,
- "Id": 0,
- "Allocation": 0
}
]
}
], - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
}
Calculates and returns the allocations of a passed portfolio.
Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).
If one, or more, of the securities have neither components nor breakdowns, their actual (main) attributes are used instead.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to get the allocations |
includeLookThrough required | boolean Determines whether security look-through should be accounted for category |
category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" The category for which the allocations should be returned |
language | string The language in which to return currency name |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Allocations": [
- {
- "Category": "AssetClass",
- "Breakdowns": [
- {
- "Amount": 0,
- "Id": 0,
- "Allocation": 0
}
]
}
], - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
}
Modifies an existing portfolio. For portfolios that have not been implemented yet the portfolio positions can be modified based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). For virtual portfolios the position changes will become effective immediately. If no data is provided in all properties no changes will be made to the portfolio positions. Changing the portfolio properties (Name, ...) is possible with any portfolio type and status
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the modified portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the modified portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
AllocationsOrder | object (InstrumentSetOrder) Holds information about an order for an instrument set |
Name | string Nullable The optional new name of the portfolio. Will be ignored if not set. |
InitialInvestmentAmount | number <double> Nullable The optional new initial investment amount for the portfolio in portfolio currency. If not specified then the sum of all payin account balances linked to the portfolio will be used as initial investment amount. Can only be set for portfolios that have not been ordered yet. |
CurrencyId | integer <int32> Nullable The optional new currency ID of the portfolio. |
RebalancingType | string (PortfolioRebalancingTypeId) Enum: "NoRebalancing" "Manual" "Automatic" |
IsBreached | boolean Nullable The optional parameter which tells if a portfolio is breached. If not passed all portfolios will be returned |
CustomAttributes | string Nullable Custom attributes specific to the tenant |
RiskCategoryId | integer <int32> Nullable The optional new risk category ID of the portfolio |
PortfolioStatus | string (PortfolioStatusId) Enum: "NotImplemented" "InExecution" "Implemented" "Blocked" "Closed" |
ExternalId | string Nullable The optional ExternalId of the portfolio |
PortfolioType | string (PortfolioTypeId) Enum: "Real" "Virtual" "Slice" |
Fees | Array of objects (FeeRequest) Nullable An optional set of fees and fees definitions to be associated with the portfolio. Is only used if the current status of the portfolio is not Implemented. If not specified then the portfolio will inherit the fees and fees definitions of the ProductId only if the ProductId will be differit by the one associated with the portfolio. |
Accounts | Array of objects (PortfolioAccountInfo) Nullable An optional list of accounts the portfolio will be associated with. |
ProductId | integer <int32> Nullable The optional ID of the product that the portfolio will be associated with. |
ContactGroupId | integer <int32> Nullable The optional ID of the contact group that the portfolio will be associated with. |
OptimizationConstraints | object (OptimizationConstraintRequest) |
BenchmarkId | integer <int32> Nullable The benchmark associated with the portfolio |
EsgPreferences | Array of objects (EsgPreference) Nullable The ESG preferences associated with the portfolio |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ModelPortfolioId": 1,
- "PortfolioProposalId": 1,
- "AllocationsOrder": {
- "AllocationType": "Percentage",
- "Allocations": [
- {
- "InstrumentId": 1,
- "Allocation": 0.2
}, - {
- "InstrumentId": 2,
- "Allocation": 0.3
}, - {
- "InstrumentId": 3,
- "Allocation": 0.5
}
]
}, - "Name": "C002747290",
- "InitialInvestmentAmount": 100,
- "CurrencyId": 3,
- "RebalancingType": "Automatic",
- "IsBreached": false,
- "CustomAttributes": "{\"Description\": \"The Portfolio the Client always wanted to have.\"}",
- "RiskCategoryId": 1,
- "PortfolioStatus": "NotImplemented",
- "ExternalId": "EXT123",
- "PortfolioType": "Real",
- "Fees": [
- {
- "Id": 1,
- "IsPercentage": false,
- "ValidFrom": "2024-12-19T14:35:37.7082179+00:00",
- "ValidTo": "2025-01-18T14:35:37.7082191+00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 4,
- "FeeDefinitions": [
- {
- "Id": 1,
- "FeeId": 2,
- "ValueFrom": 10,
- "ValueTo": 20,
- "FeeValue": 3
}
]
}
], - "Accounts": [
- {
- "Account": {
- "Id": 1
}, - "IsDefaultCustodyAccount": false,
- "IsPayoutAccount": false,
- "IsPayinAccount": true
}
], - "ProductId": 5,
- "ContactGroupId": 1,
- "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "BenchmarkId": 5,
- "EsgPreferences": [
- {
- "Id": 0,
- "EsgComponentId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.9,
- "MinThreshold": 1,
- "MaxThreshold": 2
}
], - "UpdateProperties": [
- "Name",
- "AllocationsOrder",
- "IsBreached",
- "Accounts",
- "ContactGroupId",
- "CurrencyId",
- "CustomAttributes",
- "ExternalId",
- "Fees",
- "InitialInvestmentAmount",
- "ModelPortfolioId",
- "PortfolioProposalId",
- "PortfolioStatus",
- "PortfolioType",
- "ProductId",
- "RebalancingType",
- "RiskCategoryId",
- "OptimizationConstraints",
- "BenchmarkId",
- "EsgPreferences"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies a portfolio proposal. The portfolio proposal can be modified based on a set of instrument allocations (passed in the InstrumentAllocations property) or based on an existing model portfolio (passed in the ModelPortfolioId property). If no data is provided in both properties no changes will be made to the portfolio proposal details, but only to the properties specified (Name, ...)
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
portfolioProposalId required | integer <int32> The ID of the portfolio proposal to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the portfolio proposal should be changed to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
InstrumentAllocations | Array of objects (InstrumentInformation) Nullable The instruments and their allocations of the portfolio proposal. Is only used if ModelPortfolioId is not set. |
Name | string Nullable The optional name of the portfolio proposal |
PortfolioProposalStatusId | integer <int32> The ID of proposal status |
ProductId | integer <int32> The ID of the product that the portfolio proposal belongs to |
CurrencyId | integer <int32> The ID of proposal currency |
BenchmarkId | integer <int32> Nullable The ID of the security used as a benchmark index |
PortfolioId | integer <int32> Nullable The ID of the portfolio that the portfolio proposal is linked to |
ExpectedReturn | number <double> Nullable This is the expected return passed by the user - if not passed the value is calculated by the application at the time of the proposal creation |
ExpectedRisk | number <double> Nullable This is the expected risk passed by the user - if not passed the value is calculated by the application at the time of the proposal creation |
RecommendedInvestment | number <double> Nullable This is the recommended investment for the proposal |
OptimizationConstraints | object (OptimizationConstraintRequest) |
UpdateProperties | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InstrumentAllocations": [
- {
- "Notes": [
- {
- "MemberId": 2,
- "Text": "Good!"
}, - {
- "MemberId": 3,
- "Text": "Best!"
}
], - "IsNotAdvised": false,
- "InstrumentId": 1,
- "Allocation": 0.2
}, - {
- "IsNotAdvised": true,
- "InstrumentId": 2,
- "Allocation": 0.3
}, - {
- "IsNotAdvised": true,
- "InstrumentId": 3,
- "Allocation": 0.5
}
], - "Name": "C002747291",
- "PortfolioProposalStatusId": 1,
- "ProductId": 1,
- "CurrencyId": 1,
- "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 20,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "SecurityConstraints": [
- {
- "SecurityId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.2
}
]
}, - "UpdateProperties": [
- "Name",
- "ModelPortfolioId",
- "InstrumentAllocations",
- "OptimizationConstraints",
- "BenchmarkId",
- "ExpectedReturn",
- "ProductId",
- "CurrencyId",
- "ExpectedRisk",
- "PortfolioId",
- "PortfolioProposalStatusId",
- "RecommendedInvestment"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies specific properties of a portfolio changeset
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio the orders belong to |
portfolioChangeId required | integer <int32> The ID of the portfolio changeset to be modified |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
Availability | string (PortfolioChangeAvailabilityId) Enum: "OnHold" "Ready" |
Status | string (PortfolioChangeStatusId) Enum: "ToBeProcessed" "Processed" "Canceled" "Failed" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Availability": "Ready",
- "Status": "ToBeProcessed"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies a model portfolio.
memberId required | integer <int32> The member ID of the RM |
modelPortfolioId required | integer <int32> The ID of the model portfolio to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Name | Array of objects (LocalizedValue) Nullable The name of the model portfolio |
Description | Array of objects (LocalizedValue) Nullable The optional description of the model portfolio |
MinInvestment | number <double> Nullable This is the minimum investment for the model portfolio |
MaxInvestment | number <double> Nullable This is the maximum investment for the model portfolio |
ExpectedReturn | number <double> Nullable This is the expected return of the model portfolio |
ExpectedRisk | number <double> Nullable This is the expected risk of the model portfolio |
TimeHorizon | integer <int32> Nullable |
IsActive | boolean |
IsEditable | boolean This determines whether a Proposal / Portfolio that is based on this model can be modified |
BenchmarkId | integer <int32> Nullable This is the id of the benchmark associated with the model portfolio |
TypeId | string (ModelPortfolioTypeId) Enum: "InstrumentBased" "AssetAllocationBased" |
AllocationTypeId | string (ModelPortfolioAllocationTypeId) Enum: "SaaModel" "TaaModel" "NormalModel" |
DerivedFromModelPortfolioId | integer <int32> Nullable The Id of the model portfolio from which the current model portfolio derives. |
OptimizationTypeId | integer <int32> Nullable The optional optimization type of the model portfolio |
RiskCategoryId | integer <int32> Nullable |
RiskCategoryDefinitionId | integer <int32> Nullable |
Factsheet | object (Factsheet) The fact-sheet URL for the model portfolio |
CustomAttributes | string Nullable |
InstrumentAllocations | Array of objects (InstrumentAllocation) Nullable |
Fees | Array of objects (FeeRequest) Nullable A set of fees and fees definitions to be associated with the model portfolio. If for a fee the FeeDefinitions node is omitted then only the fee properties will be updated. |
OptimizationConstraints | object (OptimizationConstraintRequest) |
ExternalId | string Nullable This is the External Id of the model portfolio |
UpdateProperties | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": [
- {
- "LanguageCode": "en",
- "Value": "Model portfolio name in english"
}, - {
- "LanguageCode": "de",
- "Value": "Model portfolio name in german"
}
], - "Description": [
- {
- "LanguageCode": "en",
- "Value": "Model portfolio description in english"
}, - {
- "LanguageCode": "de",
- "Value": "Model portfolio description in german"
}
], - "MinInvestment": 1000,
- "MaxInvestment": 10000,
- "ExpectedReturn": 1,
- "ExpectedRisk": 1,
- "TimeHorizon": 10,
- "IsActive": true,
- "IsEditable": true,
- "BenchmarkId": 11,
- "TypeId": "InstrumentBased",
- "AllocationTypeId": "NormalModel",
- "DerivedFromModelPortfolioId": 1,
- "OptimizationTypeId": 1,
- "RiskCategoryId": 4,
- "RiskCategoryDefinitionId": 49,
- "CustomAttributes": "{\"Description\": \"Custom Attributes of Model Portfolio.\"}",
- "InstrumentAllocations": [
- {
- "InstrumentId": 16,
- "Allocation": 0.8
}, - {
- "InstrumentId": 17,
- "Allocation": 0.2
}
], - "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2018-12-01T00:00:00",
- "ValidTo": "2021-12-31T00:00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 4,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 1.49,
- "FeeValue": 0.02,
- "InducementValue": 1
}, - {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 1.5,
- "ValueTo": 10,
- "FeeValue": 0.01,
- "InducementValue": 2
}
]
}
], - "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "ExternalId": "TEST1",
- "UpdateProperties": [
- "Name",
- "Description",
- "MinInvestment",
- "MaxInvestment",
- "ExpectedReturn",
- "ExpectedRisk",
- "TimeHorizon",
- "IsActive",
- "BenchmarkId",
- "TypeId",
- "DerivedFromModelPortfolioId",
- "AllocationTypeId",
- "OptimizationTypeId",
- "RiskCategoryDefinitionId",
- "RiskCategoryId",
- "Factsheet",
- "CustomAttributes",
- "InstrumentAllocations",
- "Fees",
- "OptimizationConstraints",
- "ExternalId"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies the status of a given set of orders. The service cannot be used to release orders.
memberId required | integer <int32> The ID of the member |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
OrderBookIds | Array of integers <int32> Nullable |
OrderBookStatus | string (OrderBookStatusId) Enum: "Reconciliation" "ToBeProcessed" "Generated" "Released" "Pulled" "Cancelled" "PartiallyExecuted" "Executed" "Error" "ThresholdBreached" "Undelivered" |
Comment | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OrderBookIds": [
- 0
], - "OrderBookStatus": "Reconciliation",
- "Comment": "string"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies a switch suggestion.
memberId required | integer <int32> The ID of the member that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio associated with the suggestion basket |
switchSuggestionId required | integer <int32> The ID of the suggestion basket |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ValidTill required | string <date-time> |
Switches required | Array of objects (SwitchPair) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ValidTill": "2024-12-28T14:35:37.7248043Z",
- "Switches": [
- {
- "From": {
- "SecurityId": 6,
- "Allocation": 0.2
}, - "To": [
- {
- "SecurityId": 5,
- "Allocation": 0.33
}, - {
- "SecurityId": 7,
- "Allocation": 0.67
}
]
}, - {
- "From": {
- "SecurityId": 112,
- "Allocation": 0.66
}, - "To": [
- {
- "SecurityId": 23,
- "Allocation": 0.25
}, - {
- "SecurityId": 5,
- "Allocation": 0.75
}
]
}
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies specific attributes of an order.
memberId required | integer <int32> The ID of the member |
orderBookId required | integer <int32> The ID of the order |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
FundingAccountId | integer <int32> Nullable The funding account associated with the Order |
CustodyAccountId | integer <int32> The custody account associated with the Order |
StockExchangeId | integer <int32> Nullable The stock exchange associated with the Order |
Quantity | number <double> Nullable The quantity associated with the Order |
StockExchangeOrderType | string (StockExchangeOrderTypeId) Enum: "Market" "Limit" "Stop" "StopLimit" |
LimitPrice | number <double> Nullable The limit price associated with the Order |
StopPrice | number <double> Nullable The stop price associated with the Order |
ValidityType | string (StockExchangeOrderValidityId) Enum: "GoodTillDate" "DayOrder" "GoodTillCancelled" "ImmediateOrCancel" "FillOrKill" "OnTheOpen" "OnTheClose" |
ValidityDate | string <date-time> Nullable The validity date associated with the Order |
Status | string (OrderBookStatusId) Enum: "Reconciliation" "ToBeProcessed" "Generated" "Released" "Pulled" "Cancelled" "PartiallyExecuted" "Executed" "Error" "ThresholdBreached" "Undelivered" |
IntegrationStatus | string Nullable The integration status associated with the Order |
ExternalId | string Nullable The external id associated with the Order |
Comment | string Nullable A comment associated with the Order |
UpdateProperties | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CustodyAccountId": 1,
- "StockExchangeId": 190,
- "Quantity": 34333,
- "StockExchangeOrderType": "Limit",
- "LimitPrice": 4343.45,
- "StopPrice": 6343.45,
- "ValidityType": "OnTheClose",
- "ValidityDate": "2024-12-21T14:35:37.7264664Z",
- "Status": "PartiallyExecuted",
- "IntegrationStatus": "Ext1Released",
- "ExternalId": "125346127534",
- "Comment": "Comment",
- "UpdateProperties": [
- "FundingAccountId",
- "CustodyAccountId",
- "StockExchangeId",
- "Quantity",
- "StockExchangeOrderType",
- "LimitPrice",
- "StopPrice",
- "ValidityType",
- "ValidityDate",
- "Comment",
- "Status",
- "IntegrationStatus",
- "ExternalId"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies the status of a given set of block orders. The service cannot be used to release block orders.
memberId required | integer <int32> The ID of the member |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
BlockOrderBookIds | Array of integers <int32> Nullable |
BlockOrderStatus | string (OrderBookStatusId) Enum: "Reconciliation" "ToBeProcessed" "Generated" "Released" "Pulled" "Cancelled" "PartiallyExecuted" "Executed" "Error" "ThresholdBreached" "Undelivered" |
CancelAssociatedOrders | boolean Nullable |
OrderStatus | string (OrderBookStatusId) Enum: "Reconciliation" "ToBeProcessed" "Generated" "Released" "Pulled" "Cancelled" "PartiallyExecuted" "Executed" "Error" "ThresholdBreached" "Undelivered" |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "BlockOrderBookIds": [
- 0
], - "BlockOrderStatus": "Reconciliation",
- "CancelAssociatedOrders": true,
- "OrderStatus": "Reconciliation"
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets the transactions of a portfolio within an optional date range. All currency values are returned in the base currency of the portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to retrieve the transactions for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
SecurityType | string (PortfolioTransactionSecurityTypeFilter) Enum: "Instruments" "Liquidity" "All" |
Page | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
From | string <date-time> Nullable An optional start date for returning only transactions with this date or newer |
To | string <date-time> Nullable An optional end date for returning only transactions with this date or older |
SecurityId | integer <int32> Nullable An optional security ID for returning only transactions for this security |
AccountId | integer <int32> Nullable An optional account ID for returning only transactions for this account |
FundingId | integer <int32> Nullable An optional funding ID for returning only transactions for this funding |
TransactionType | string (AccountTransactionTypeId) Enum: "Credit" "Debit" |
TransactionStatus | string (AccountTransactionStatusId) Enum: "ToBeExecuted" "Executed" "Cancelled" "Failed" |
IsPerformanceRelevant | boolean Nullable An optional performance relevance flag for returning only transactions that have this flag set as specified |
CorrelationIds | Array of strings <uuid> Nullable An optional ID array for returning only transactions matching these correlation IDs |
ExecutionDateFrom | string <date-time> Nullable An optional start value date for returning only transactions with this execution date or newer |
ExecutionDateTo | string <date-time> Nullable An optional end value date for returning only transactions with this execution date or older |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SecurityType": "All",
- "Page": 1,
- "PageSize": 10,
- "From": "2024-12-18T00:00:00+00:00",
- "To": "2024-12-18T00:00:00+00:00",
- "SecurityId": 5,
- "AccountId": 34,
- "FundingId": 7,
- "TransactionType": "Credit",
- "TransactionStatus": "ToBeExecuted",
- "IsPerformanceRelevant": false,
- "CorrelationIds": [
- "37813aa1-9011-4e80-91fb-97dbe22f8d4a"
], - "ExecutionDateFrom": "2024-12-18T00:00:00+00:00",
- "ExecutionDateTo": "2024-12-18T00:00:00+00:00"
}
{- "Transactions": [
- {
- "Id": 43,
- "SecurityId": 94,
- "AccountId": 34,
- "SecurityName": "AIRBUS GROUP",
- "AccountName": "00250507603002747290",
- "Date": "2018-05-15T00:00:00",
- "Quantity": 500,
- "Price": 30.22,
- "Value": 1443.645154,
- "FxRate": 1,
- "Type": {
- "Id": 2,
- "Name": "Sell"
}, - "Fees": 100.009,
- "FundingId": 1,
- "CorrelationId": "00000000-0000-0000-0000-000000000000"
}, - {
- "Id": 42,
- "SecurityId": 94,
- "AccountId": 34,
- "SecurityName": "AIRBUS GROUP",
- "AccountName": "00250507603002747290",
- "Date": "2018-04-15T00:00:00",
- "Quantity": 250,
- "Price": 22.28,
- "Value": 5774.580614,
- "FxRate": 1,
- "Type": {
- "Id": 1,
- "Name": "Buy"
}, - "Fees": 455.888,
- "CorrelationId": "00000000-0000-0000-0000-000000000000"
}
], - "Currency": {
- "Id": 2,
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "TotalNumberOfResults": 30
}
Creates a portfolio. The portfolio can be created based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). If no data in all properties is provided an empty portfolio will be created. The newly created portfolio will always have the status "NotImplemented" (PortfolioStatusId = 1) If the optional contactGroupId parameter is passed then the contact must be part of the contact group provided.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
language required | string The language in which to return all properties |
contactGroupId | integer <int32> The ID of the contact group that has access to the portfolio |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the new portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the new portfolio should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
AllocationsOrder | object (InstrumentSetOrder) Holds information about an order for an instrument set |
Name | string Nullable The optional name of the new portfolio |
ProductId | integer <int32> Nullable The ID of the product that the new portfolio belongs to. If not passed a configured default will be used. |
Accounts | Array of objects (PortfolioAccountInfo) Nullable A list of accounts the portfolio will be associated with. |
PortfolioType | string (PortfolioTypeId) Enum: "Real" "Virtual" "Slice" |
PortfolioStatus | string (PortfolioStatusId) Enum: "NotImplemented" "InExecution" "Implemented" "Blocked" "Closed" |
RebalancingType | string (PortfolioRebalancingTypeId) Enum: "NoRebalancing" "Manual" "Automatic" |
InitialInvestmentAmount | number <double> Nullable The optional initial investment amount for the new portfolio in portfolio currency. If not specified then the sum of all payin account balances linked to the portfolio will be used as initial investment amount. |
CurrencyId | integer <int32> Nullable The currency ID of the portfolio. If not passed the one associated with the contact or the system default will be used. |
CustomAttributes | string Nullable Custom attributes specific to the tenant |
ExternalId | string Nullable The optional ExternalId of the new portfolio |
RiskCategoryId | integer <int32> Nullable The optional risk category ID of the new portfolio |
Fees | Array of objects (FeeRequest) Nullable A set of fees and fees definitions to be associated with the portfolio. If not specified then the portfolio will inherit the fees and fees definitions of the ProductId associated with the portfolio. |
OptimizationConstraints | object (OptimizationConstraintRequest) |
BenchmarkId | integer <int32> Nullable The benchmark associated with the portfolio |
EsgPreferences | Array of objects (EsgPreference) Nullable The ESG preferences associated with the portfolio |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ModelPortfolioId": 4,
- "Name": "Albert's Portfolio Slice",
- "ProductId": 1,
- "Accounts": [
- {
- "Account": {
- "Id": 2
}, - "IsDefaultCustodyAccount": true,
- "IsPayoutAccount": false,
- "IsPayinAccount": false
}, - {
- "Account": {
- "Id": 1
}, - "IsDefaultCustodyAccount": false,
- "IsPayoutAccount": true,
- "IsPayinAccount": true
}
], - "PortfolioType": "Real",
- "PortfolioStatus": "NotImplemented",
- "RebalancingType": "Automatic",
- "InitialInvestmentAmount": 100000,
- "CurrencyId": 2,
- "CustomAttributes": "{\"Description\": \"The Portfolio the Client always wanted to have.\"}",
- "ExternalId": "TestExternalId",
- "RiskCategoryId": 2,
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": false,
- "ValidFrom": "2024-11-18T00:00:00+00:00",
- "ValidTo": "2025-01-18T00:00:00+00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 4,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 10,
- "ValueTo": 20,
- "FeeValue": 3
}
]
}
], - "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "BenchmarkId": 5,
- "EsgPreferences": [
- {
- "Id": 0,
- "EsgComponentId": 1,
- "MinWeight": 0.1,
- "MaxWeight": 0.9,
- "MinThreshold": 1,
- "MaxThreshold": 2
}
]
}
{- "Id": 0,
- "UId": "string"
}
Adds a specific amount to a portfolio. Doesn't trigger a cash transaction from an external account to the portfolio's cash account. Instead cash is moved from the portfolio's cash account to the custody account by issuing buy orders. The new amount will be distributed amongst the portfolio securities based on their allocation values and a buy order will be created. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to top up |
topUpAmount required | number <double> The amount to add to the portfolio in portfolio currency. Must be > 0. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Sells a specific amount from a portfolio. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The reduction amount will be distributed amongst the portfolio securities based on their allocation values and a sell order will be created. Depending on the allocation values and actual prices it is possible that not the exact amount will be sold. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to sell from |
amount required | number <double> The amount to sell from the portfolio in portfolio currency. Must be > 0. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Sells a whole portfolio. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to sell completely |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Orders a portfolio. Orders an existing portfolio that has not been implemented yet. The portfolio positions can be modified based on a set of instrument allocation orders (passed in the AllocationsOrder property), on an existing model portfolio (passed in the ModelPortfolioId property) or based on an existing portfolio proposal (passed in the PortfolioProposalId property). The change will not become effective immediately, only after the order was executed successfully. For virtual portfolios the position changes will become effective immediately.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to order |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
CurrencyId | integer <int32> Nullable The optional new currency ID of the portfolio. |
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the ordered portfolio should be based on (having the same instruments and allocations). If set, the AllocationsOrder property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the ordered portfolio should be based on (having the same instruments and allocations). If set, the AllocationsOrder property is ignored. |
AllocationsOrder | object (InstrumentSetOrder) Holds information about an order for an instrument set |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "AllocationsOrder": {
- "AllocationType": "Percentage",
- "Allocations": [
- {
- "InstrumentId": 1,
- "Allocation": 0.2
}, - {
- "InstrumentId": 2,
- "Allocation": 0.3
}, - {
- "InstrumentId": 3,
- "Allocation": 0.5
}
]
}, - "ForceOrderGeneration": false
}
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Creates a portfolio proposal. The portfolio proposal can be created based on a set of instrument allocations (passed in the InstrumentAllocations property), on an existing portfolio proposal (passed in the PortfolioProposalId property) or based on an existing model portfolio (passed in the ModelPortfolioId property). If no data in all properties is provided a ValidationException will be thrown. The newly created portfolio proposal will always have the status "Created" (PortfolioProposalStatusId = 1). If the optional contactGroupId parameter is passed then the contact must be part of the contact group provided.
contactId required | integer <int32> The ID of the contact that has access to the portfolio proposal |
language required | string The language in which to return all properties |
contactGroupId | integer <int32> The ID of the contact group that has access to the portfolio proposal |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the new portfolio proposal should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the new portfolio proposal should be based on (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
InstrumentAllocations | Array of objects (InstrumentInformation) Nullable The instruments and their allocations for the portfolio proposal to create. Is only used if ModelPortfolioId and PortfolioProposalId are not set. |
Name | string Nullable The optional name of the new portfolio proposal |
ProductId | integer <int32> Nullable The ID of the product that the new portfolio proposal belongs to |
PortfolioId | integer <int32> Nullable The ID of the portfolio that the new portfolio proposal is linked to |
CurrencyId | integer <int32> Nullable This is the optional currency id which will be the proposal's currency in case no PortfolioId is passed |
ExpectedReturn | number <double> Nullable This is the expected return passed by the user - if not passed the value is calculated by the application at the time of the proposal creation |
ExpectedRisk | number <double> Nullable This is the expected risk passed by the user - if not passed the value is calculated by the application at the time of the proposal creation |
RecommendedInvestment | number <double> Nullable This is the recommended investment for the proposal |
BenchmarkId | integer <int32> Nullable This is the id of the benchmark associated with the proposal |
OptimizationConstraints | object (OptimizationConstraintRequest) |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ModelPortfolioId": 4,
- "InstrumentAllocations": [
- {
- "Notes": [
- {
- "MemberId": 1,
- "Text": "This is an advisory note!"
}, - {
- "MemberId": 2,
- "Text": "This is an advisory note!"
}
], - "IsNotAdvised": false,
- "InstrumentId": 94,
- "Allocation": 0.8
}, - {
- "Notes": [
- {
- "MemberId": 1,
- "Text": "This is another advisory note!"
}, - {
- "MemberId": 2,
- "Text": "This is another advisory note!"
}
], - "IsNotAdvised": false,
- "InstrumentId": 110,
- "Allocation": 0.2
}
], - "Name": "Albert's NEW Portfolio",
- "ProductId": 3,
- "PortfolioId": 1,
- "CurrencyId": 3,
- "ExpectedReturn": 0.125,
- "ExpectedRisk": 0.075,
- "RecommendedInvestment": 100000,
- "BenchmarkId": 94,
- "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}
}
{- "Id": 0
}
Rebalances an existing implemented portfolio. The portfolio is rebalanced to a target set of new instruments/allocations. The target can be specified as a set of instrument allocations (passed in the InstrumentAllocations property), as an existing model portfolio (passed in the ModelPortfolioId property) or as an existing portfolio proposal (passed in the PortfolioProposalId property). If no target is passed the last implemented change to the portfolio will be used as the target. For virtual portfolios the position changes will become effective immediately, for real portfolios a rebalancing order will be created.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to rebalance |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the portfolio should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the portfolio should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
InstrumentAllocations | Array of objects (RebalancePortfolioInstrumentAllocation) Nullable The list of all instruments and their allocations that the portfolio should be rebalanced to. Is only used if ModelPortfolioId and PortfolioProposalId are not set. |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OptimizationConstraints | object (OptimizationConstraintRequest) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "InstrumentAllocations": [
- {
- "StockExchangeId": 1,
- "InstrumentId": 1,
- "Allocation": 0.2
}, - {
- "StockExchangeId": 2,
- "InstrumentId": 2,
- "Allocation": 0.3
}, - {
- "InstrumentId": 3,
- "Allocation": 0.5
}
], - "ForceOrderGeneration": false,
- "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}
}
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Rebalances existing real, implemented portfolios, depending on the inputs provided:
Pass an empty request - rebalance all real, implemented, Portfolios (with rebalancing type set to Automatic) to the respective ModelPortfolioId, PortfolioProposalId, latest successful allocation-based portfolio change, assigned to each Portfolio.
Pass an array of PortfolioIds - for the passed array of Portfolios, rebalance the real, implemented, Portfolios to the respective ModelPortfolioId, PortfolioProposalId, latest successful allocation-based portfolio change, assigned to each Portfolio.
Pass a ProductId - for the real, implemented, Portfolios (with rebalancing type set to Automatic) assigned to the passed ProductId rebalance to the respective ModelPortfolioId, PortfolioProposalId, latest successful allocation-based portfolio change, assigned to each Portfolio.
Pass an array of PortfolioIds and a ModelPortfolioId - for the real, implemented, Portfolios passed rebalance to the ModelPortfolioId provided.
Pass an array of PortfolioIds and a PortfolioProposalId - for the real, implemented, Portfolios passed rebalance to the PortfolioProposalid provided.
Pass an array of PortfolioIds and InstrumentAllocations - for the real, implemented, Portfolios passed rebalance to the instrument / allocation set provided.
Pass a ModelPortfolioId - for the real, implemented, Portfolios (with rebalancing type set to Automatic) that are associated to the ModelPortfolioId passed, rebalance to that ModelPortfolioId.
Pass a PortfolioProposalId - for the real, implemented, Portfolios (with rebalancing type set to Automatic) that are associated to the PortfolioProposalId passed, rebalance to that PortfolioProposalId.
Identical to the other endpoint, except for the memberId that here it is present in the request URI (but not used).
This API is deprecated. Use POST /v1.0/portfolios/rebalance instead.
memberId required | integer <int32> The ID of the member that initiated the rebalancing |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
PortfolioIds | Array of integers <int32> Nullable The portfolio IDs to rebalance. If omitted, all implemented portfolios will be rebalanced or, if a productId is passed, only the implemented portfolios of that product. |
ProductId | integer <int32> Nullable The product ID of the portfolios to rebalance. If passed, all implemented portfolios of that product will be rebalanced. |
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the portfolios should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the portfolios should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
InstrumentAllocations | Array of objects (PortfolioManagement.Abstractions.Portfolios.RebalancePortfolios.InstrumentAllocation) Nullable The list of all instruments and their allocations that the portfolios should be rebalanced to. Is only used if ModelPortfolioId and PortfolioProposalId are not set. |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioIds": [
- 0
], - "ProductId": 0,
- "ModelPortfolioId": 0,
- "PortfolioProposalId": 0,
- "InstrumentAllocations": [
- {
- "InstrumentId": 0,
- "Allocation": 0
}
], - "ForceOrderGeneration": true
}
{- "LongRunningRequestId": "string"
}
Rebalances existing real, implemented portfolios, depending on the inputs provided:
Pass an empty request - rebalance all real, implemented, Portfolios (with rebalancing type set to Automatic) to the respective ModelPortfolioId, PortfolioProposalId, latest successful allocation-based portfolio change, assigned to each Portfolio.
Pass an array of PortfolioIds - for the passed array of Portfolios, rebalance the real, implemented, Portfolios to the respective ModelPortfolioId, PortfolioProposalId, latest successful allocation-based portfolio change, assigned to each Portfolio.
Pass a ProductId - for the real, implemented, Portfolios (with rebalancing type set to Automatic) assigned to the passed ProductId rebalance to the respective ModelPortfolioId, PortfolioProposalId, latest successful allocation-based portfolio change, assigned to each Portfolio.
Pass an array of PortfolioIds and a ModelPortfolioId - for the real, implemented, Portfolios passed rebalance to the ModelPortfolioId provided.
Pass an array of PortfolioIds and a PortfolioProposalId - for the real, implemented, Portfolios passed rebalance to the PortfolioProposalid provided.
Pass an array of PortfolioIds and InstrumentAllocations - for the real, implemented, Portfolios passed rebalance to the instrument / allocation set provided.
Pass a ModelPortfolioId - for the real, implemented, Portfolios (with rebalancing type set to Automatic) that are associated to the ModelPortfolioId passed, rebalance to that ModelPortfolioId.
Pass a PortfolioProposalId - for the real, implemented, Portfolios (with rebalancing type set to Automatic) that are associated to the PortfolioProposalId passed, rebalance to that PortfolioProposalId.
Identical to the other endpoint, except for the memberId that here it is not present in the request URI.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
PortfolioIds | Array of integers <int32> Nullable The portfolio IDs to rebalance. If omitted, all implemented portfolios will be rebalanced or, if a productId is passed, only the implemented portfolios of that product. |
ProductId | integer <int32> Nullable The product ID of the portfolios to rebalance. If passed, all implemented portfolios of that product will be rebalanced. |
ModelPortfolioId | integer <int32> Nullable The ID of a model portfolio that the portfolios should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
PortfolioProposalId | integer <int32> Nullable The ID of a portfolio proposal that the portfolios should be rebalanced to (having the same instruments and allocations). If set, the InstrumentAllocations property is ignored. |
InstrumentAllocations | Array of objects (PortfolioManagement.Abstractions.Portfolios.RebalancePortfolios.InstrumentAllocation) Nullable The list of all instruments and their allocations that the portfolios should be rebalanced to. Is only used if ModelPortfolioId and PortfolioProposalId are not set. |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioIds": [
- 0
], - "ProductId": 0,
- "ModelPortfolioId": 0,
- "PortfolioProposalId": 0,
- "InstrumentAllocations": [
- {
- "InstrumentId": 0,
- "Allocation": 0
}
], - "ForceOrderGeneration": true
}
{- "LongRunningRequestId": "string"
}
Cancels an existing order from the order book
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio the order belongs to |
orderBookId required | integer <int32> The ID of the order book entry to cancel |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Triggers a long running request to release orders from the Order Book.Note that if the Block Order Book is enabled then market orders belonging a product are pulled together as Block Orders. If the Block Order Book is disabled instead, then Orders are released directly on the service bus.Note that the endpoint can either be provided with a list of Orders to release (via the orderBookIds array) or told to release all orders(via the releaseAllOrders variable - in this scenario all orders in status Generated are released); note that both variables cannot be passed.
language required | string The language to use for all language dependent properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO containing a list of IDs of order book entries to be released
OrderBookIds | Array of integers <int32> Nullable Specific order book Ids to be released |
ReleaseAllOrders | boolean Nullable If true, all orders in status Generated are released |
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OrderBookIds": [
- 1,
- 2,
- 3,
- 4,
- 5
], - "ReleaseAllOrders": false
}
{- "LongRunningRequestId": "string"
}
Releases orders from the block order book. All block orders with status "Generated" are published to the service bus.
language required | string The language to use for all language dependent properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO containing a list of IDs of block order book entries to be released
BlockOrderBookIds | Array of integers <int32> Nullable Either BlockOrderBookIds or ReleaseAllBlockOrders can be specified, but not both. |
ReleaseAllBlockOrders | boolean Nullable Either BlockOrderBookIds or ReleaseAllBlockOrders can be specified, but not both. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "BlockOrderBookIds": [
- 1,
- 2,
- 3,
- 4,
- 5
], - "ReleaseAllBlockOrders": false
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Releases orders of a portfolio from the order book. The market orders belonging to a product with enabled block orders are pulled together as block orders, all other order types are published to the service bus.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio the orders belong to |
language required | string The language to use for all language dependent properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO containing an optional list of IDs of order book entries to be released. If not passed then all orders with status 'Generated' belonging to the portfolio are released.
OrderBookIds | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OrderBookIds": [
- 1,
- 2,
- 3,
- 4,
- 5
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
The type of order that will be simulated is determined by the combination of properties set in the parameter DTO.
The following combinations and the resulting types are supported. All amounts are given in the currency specified in the CurrencyId parameter.
Initial order
TargetInstrumentAllocations - Contains the desired instrument set with allocations.
Amount - Contains the amount to be distributed according to the allocations given in TargetInstrumentAllocations.
Top up
SourceInstrumentAllocations - Contains the instrument set to top up.
SourceAmount - Contains the current market value of the instrument set given in SourceInstrumentAllocations.
Amount - Contains the amount to top up.
TargetInstrumentAllocations - If "AllowDriftingInvestments" is set to false in the global settings "Ordering" group the top up will result in a rebalance. In this case the instrument set to rebalance to needs to be provided in this property.
Sell/Sell all
SourceInstrumentAllocations - Contains the instrument set to sell from.
SourceAmount - Contains the current market value of the instrument set given in SourceInstrumentAllocations.
Amount - Contains the amount to sell, given as a negative value. If this amount * -1 is the same as the amount given in SourceAmount, a sell all is assumed.
TargetInstrumentAllocations - If "AllowDriftingSells" is set to false in the global settings "Ordering" group a normal sell (not a sell all!) will result in a rebalance. In this case the instrument set to rebalance to needs to be provided in this property.
Rebalancing
SourceInstrumentAllocations - Contains the instrument set to rebalance from.
SourceAmount - Contains the current market value of the instrument set given in SourceInstrumentAllocations.
TargetInstrumentAllocations - Contains the instrument set to rebalance to.
contactId required | integer <int32> The ID of the contact |
language required | string The language to use for all language dependent properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
ProductId | integer <int32> The product ID of the order. |
CurrencyId | integer <int32> The base currency ID of the order. |
SourceAmount | number <double> Nullable The source amount of the order. |
Amount | number <double> Nullable The amount of the order. |
SourceInstrumentAllocations | Array of objects (InstrumentAllocation) Nullable The source list of all instruments and their allocations. |
TargetInstrumentAllocations | Array of objects (InstrumentAllocation) Nullable The target list of all instruments and their allocations. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ProductId": 1,
- "CurrencyId": 2,
- "Amount": 10000,
- "TargetInstrumentAllocations": [
- {
- "InstrumentId": 59,
- "Allocation": 0.6
}, - {
- "InstrumentId": 94,
- "Allocation": 0.4
}
]
}
{- "OrderBookEntries": [
- {
- "Id": 0,
- "PortfolioChangeId": 0,
- "Quantity": 102.98661174047373,
- "Price": 58.26,
- "AmountAccountCurrency": 60000,
- "AmountSecurityCurrency": 60000,
- "CreateDate": "2024-12-18T14:35:37.7529059Z",
- "PortfolioId": 0,
- "PortfolioUId": "00000000-0000-0000-0000-000000000000",
- "ProductId": 0,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "Security": {
- "Id": 59,
- "Name": "FIDELITY EUROPEAN SM",
- "Isin": "DE0005557508",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Reconciliation",
- "Id": 1,
- "Name": "Reconciliation"
}, - "StockExchangeOrderType": {
- "Key": "Market",
- "Id": 1,
- "Name": "Market"
}, - "OrderValidity": {
- "Key": "GoodTillDate",
- "Id": 1,
- "Name": "GoodTilDate"
}, - "Notes": [ ],
- "OrderType": {
- "Key": "Buy",
- "Id": 1,
- "Name": "Buy"
}, - "FxRate": 0,
- "OriginalQuantity": 0
}, - {
- "Id": 0,
- "PortfolioChangeId": 0,
- "Quantity": 40,
- "Price": 99.39,
- "AmountAccountCurrency": 3975.6,
- "AmountSecurityCurrency": 3975.6,
- "CreateDate": "2024-12-18T14:35:37.7529131Z",
- "PortfolioId": 0,
- "PortfolioUId": "00000000-0000-0000-0000-000000000000",
- "ProductId": 0,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "ProductName": "Execution Only",
- "Security": {
- "Id": 94,
- "Name": "AIRBUS GROUP",
- "Isin": "NL0000235190",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Reconciliation",
- "Id": 1,
- "Name": "Reconciliation"
}, - "StockExchangeOrderType": {
- "Key": "Market",
- "Id": 1,
- "Name": "Market"
}, - "OrderValidity": {
- "Key": "GoodTillDate",
- "Id": 1,
- "Name": "GoodTilDate"
}, - "Notes": [ ],
- "OrderType": {
- "Key": "Buy",
- "Id": 1,
- "Name": "Buy"
}, - "FxRate": 0,
- "OriginalQuantity": 0
}
], - "ChangeSetType": "InitialOrder"
}
Generates orders in the order book for pending changesets.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio the changesets belong to |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO.
PortfolioChangeIds | Array of integers <int32> Nullable The list of portfolio change IDs to generate orders for |
ForceOrderGeneration | boolean If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled' |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioChangeIds": [
- 11,
- 21,
- 31
], - "ForceOrderGeneration": false
}
{- "PortfolioOrderResults": [
- {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 11,
- "Result": "Created"
}, - {
- "Messages": [
- "Invalid available amount for PortfolioId 2. Skipping changeset."
], - "PortfolioId": 2,
- "PortfolioChangeId": 21,
- "Result": "BalanceCheckFailed"
}, - {
- "Messages": [ ],
- "PortfolioId": 3,
- "PortfolioChangeId": 31,
- "Result": "MissingAccounts"
}
]
}
Return allocations based on trading-cart trades of a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to get the trading cart for |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "TargetInstrumentsAllocations": [
- {
- "Security": {
- "Id": 1,
- "TypeId": 2,
- "Name": "VODAFONE",
- "Isin": "VDF9500000",
- "CurrencyId": 1,
- "CurrencyIsoCode": "EUR"
}, - "Quantity": 10,
- "Investment": 1000,
- "Allocation": 0.5
}, - {
- "Security": {
- "Id": 2,
- "TypeId": 3,
- "Name": "ORANGE",
- "Isin": "ORA9500000",
- "CurrencyId": 2,
- "CurrencyIsoCode": "USD"
}, - "Quantity": 20,
- "Investment": 200,
- "Allocation": 0.25
}, - {
- "Security": {
- "Id": 2,
- "TypeId": 1,
- "Name": "Liquidity EUR",
- "CurrencyId": 1,
- "CurrencyIsoCode": "EUR"
}, - "Quantity": 1,
- "Investment": 100,
- "Allocation": 0.25
}
]
}
Orders the trading cart items of a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to delete the trading cart for |
scope | string (InstrumentTradeTypeScope) Enum: "Buy" "Sell" "All" An optional parameter to specify the scope for which to create orders for. Can be 'Sell', 'Buy' or 'All'. Defaults to 'All' if not specified. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SellOperationResult": {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1,
- "Result": "Created"
}
}, - "BuyOperationResult": {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 2,
- "Result": "MissingAccounts"
}
}, - "SellPortfolioChangeId": 1,
- "BuyPortfolioChangeId": 2
}
Simulates ordering the trading cart items of a portfolio.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to simulate the trading cart order for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Trades | Array of objects (InstrumentTrade) Nullable An optional list of trades to simulate. If not passed the current trades in the portfolio trading cart will be used. |
Scope | string (InstrumentTradeTypeScope) Enum: "Buy" "Sell" "All" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Trades": [
- {
- "InstrumentId": 59,
- "InstrumentTradeType": "Buy",
- "Amount": 60000
}, - {
- "InstrumentId": 94,
- "InstrumentTradeType": "Sell",
- "Quantity": 40
}
], - "Scope": "All"
}
{- "OrderBookEntries": [
- {
- "Id": 0,
- "PortfolioChangeId": 0,
- "Quantity": 102.98661174047373,
- "Price": 58.26,
- "AmountAccountCurrency": 60000,
- "AmountSecurityCurrency": 60000,
- "CreateDate": "2024-12-18T14:35:37.8002145Z",
- "PortfolioId": 0,
- "PortfolioUId": "00000000-0000-0000-0000-000000000000",
- "ProductId": 0,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "Security": {
- "Id": 59,
- "Name": "FIDELITY EUROPEAN SM",
- "Isin": "DE0005557508",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Reconciliation",
- "Id": 1,
- "Name": "Reconciliation"
}, - "StockExchangeOrderType": {
- "Key": "Market",
- "Id": 1,
- "Name": "Market"
}, - "OrderValidity": {
- "Key": "GoodTillDate",
- "Id": 1,
- "Name": "GoodTilDate"
}, - "Notes": [ ],
- "OrderType": {
- "Key": "Buy",
- "Id": 1,
- "Name": "Buy"
}, - "FxRate": 0,
- "OriginalQuantity": 0
}, - {
- "Id": 0,
- "PortfolioChangeId": 0,
- "Quantity": -40,
- "Price": 99.39,
- "AmountAccountCurrency": -3975.6,
- "AmountSecurityCurrency": -3975.6,
- "CreateDate": "2024-12-18T14:35:37.8002202Z",
- "PortfolioId": 0,
- "PortfolioUId": "00000000-0000-0000-0000-000000000000",
- "ProductId": 0,
- "ProductUId": "00000000-0000-0000-0000-000000000000",
- "ProductName": "Execution Only",
- "Security": {
- "Id": 94,
- "Name": "AIRBUS GROUP",
- "Isin": "NL0000235190",
- "Currency": {
- "Id": 2,
- "UId": "00000000-0000-0000-0000-000000000000",
- "Name": "Euro",
- "CurrencyCode": "EUR",
- "Symbol": "€"
}, - "Ratings": [ ],
- "SecurityStockExchanges": [ ],
- "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": false,
- "TradingUnit": 0,
- "RoundingLot": 0,
- "Factor": 0,
- "IsPricePercentage": false
}, - "Status": {
- "Key": "Reconciliation",
- "Id": 1,
- "Name": "Reconciliation"
}, - "StockExchangeOrderType": {
- "Key": "Market",
- "Id": 1,
- "Name": "Market"
}, - "OrderValidity": {
- "Key": "GoodTillDate",
- "Id": 1,
- "Name": "GoodTilDate"
}, - "Notes": [ ],
- "OrderType": {
- "Key": "Sell",
- "Id": 2,
- "Name": "Sell"
}, - "FxRate": 0,
- "OriginalQuantity": 0
}
], - "SellOrderSimulationResult": "Success",
- "BuyOrderSimulationResult": "Success",
- "Messages": [ ]
}
Creates a model portfolio.
memberId required | integer <int32> The member ID of the RM |
isPrivate required | boolean When true the model portfolio will be assigned to the MemberId making the service call |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Name required | Array of objects (LocalizedValue) The name of the new model portfolio |
Description | Array of objects (LocalizedValue) Nullable The optional description of the new model portfolio |
MinInvestment | number <double> Nullable This is the minimum investment for the model portfolio |
MaxInvestment | number <double> Nullable This is the maximum investment for the model portfolio |
ExpectedReturn | number <double> Nullable This is the expected return of the model portfolio |
ExpectedRisk | number <double> Nullable This is the expected risk of the model portfolio |
TimeHorizon | integer <int32> Nullable |
IsActive | boolean |
IsEditable | boolean This determines whether a Proposal / Portfolio that is based on this model can be modified |
BenchmarkId | integer <int32> Nullable This is the id of the benchmark associated with the model portfolio |
CustomAttributes | string Nullable |
TypeId required | string (ModelPortfolioTypeId) Enum: "InstrumentBased" "AssetAllocationBased" |
AllocationTypeId required | string (ModelPortfolioAllocationTypeId) Enum: "SaaModel" "TaaModel" "NormalModel" |
DerivedFromModelPortfolioId | integer <int32> Nullable The Id of the model portfolio from which the current model portfolio derives. |
OptimizationTypeId | integer <int32> Nullable The optional optimization type of the new model portfolio |
RiskCategoryId | integer <int32> Nullable |
RiskCategoryDefinitionId | integer <int32> Nullable |
InstrumentAllocations | Array of objects (InstrumentAllocation) Nullable |
Fees | Array of objects (FeeRequest) Nullable A set of fees and fees definitions to be associated with the model portfolio. |
OptimizationConstraints | object (OptimizationConstraintRequest) |
Factsheet | object (Factsheet) The fact-sheet URL for the model portfolio |
ExternalId | string Nullable |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": [
- {
- "LanguageCode": "en",
- "Value": "Model portfolio name in english"
}, - {
- "LanguageCode": "de",
- "Value": "Model portfolio name in german"
}
], - "Description": [
- {
- "LanguageCode": "en",
- "Value": "Model portfolio description in english"
}, - {
- "LanguageCode": "de",
- "Value": "Model portfolio description in german"
}
], - "MinInvestment": 1000,
- "MaxInvestment": 10000,
- "ExpectedReturn": 1,
- "ExpectedRisk": 1,
- "TimeHorizon": 10,
- "IsActive": true,
- "IsEditable": true,
- "BenchmarkId": 11,
- "CustomAttributes": "{\"Description\": \"Custom Attributes of Model Portfolio.\"}",
- "TypeId": "InstrumentBased",
- "AllocationTypeId": "NormalModel",
- "DerivedFromModelPortfolioId": 1,
- "OptimizationTypeId": 2,
- "RiskCategoryId": 4,
- "RiskCategoryDefinitionId": 49,
- "InstrumentAllocations": [
- {
- "InstrumentId": 16,
- "Allocation": 0.8
}, - {
- "InstrumentId": 17,
- "Allocation": 0.2
}
], - "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2018-12-01T00:00:00",
- "ValidTo": "2021-12-31T00:00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 3,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 1.49,
- "FeeValue": 0.02
}, - {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 1.5,
- "ValueTo": 10,
- "FeeValue": 0.01
}
]
}
], - "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "ExternalId": "TEST1"
}
{- "Id": 0,
- "UId": "string"
}
Creates a switch suggestion.
memberId required | integer <int32> The ID of the member that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio associated with the suggestion basket |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ValidTill required | string <date-time> |
Switches required | Array of objects (SwitchPair) |
Interaction | object (SuggestionInteraction) |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ValidTill": "2025-01-20T14:35:37.8047365Z",
- "Switches": [
- {
- "From": {
- "SecurityId": 5,
- "Allocation": 0.2
}, - "To": [
- {
- "SecurityId": 6,
- "Allocation": 0.33
}, - {
- "SecurityId": 7,
- "Allocation": 0.67
}
]
}, - {
- "From": {
- "SecurityId": 6,
- "Allocation": 0.66
}, - "To": [
- {
- "SecurityId": 23,
- "Allocation": 0.25
}, - {
- "SecurityId": 7,
- "Allocation": 0.75
}
]
}
], - "Interaction": {
- "TopicId": 1,
- "TypeId": 1,
- "MessageThreadId": 1
}
}
{- "Id": 0,
- "UId": "string"
}
Calculates the target instrument allocations of a switch suggestion. The switch suggestion can either be specified by an existing switch suggestion ID or by a custom set of switch pairs.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio associated with the suggestion basket |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
SwitchSuggestionId | integer <int32> Nullable The ID of an existing switch suggestion basket |
Switches | Array of objects (SwitchPair) Nullable A custom set of switch pairs |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Switches": [
- {
- "From": {
- "SecurityId": 6,
- "Allocation": 0.2
}, - "To": [
- {
- "SecurityId": 7,
- "Allocation": 0.67
}, - {
- "SecurityId": 5,
- "Allocation": 0.22
}
]
}, - {
- "From": {
- "SecurityId": 7,
- "Allocation": 0.66
}, - "To": [
- {
- "SecurityId": 5,
- "Allocation": 0.5
}, - {
- "SecurityId": 6,
- "Allocation": 0.5
}
]
}, - {
- "From": {
- "SecurityId": 5,
- "Allocation": 0.66
}, - "To": [
- {
- "SecurityId": 6,
- "Allocation": 0.5
}, - {
- "SecurityId": 7,
- "Allocation": 0.5
}
]
}
]
}
{- "TargetInstrumentAllocations": [
- {
- "InstrumentId": 23,
- "Allocation": 0.127414,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 5,
- "Allocation": 0.15273,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 6,
- "Allocation": 0.289636,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 7,
- "Allocation": 0.16286,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 8,
- "Allocation": 0.020256,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 9,
- "Allocation": 0.014707,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 11,
- "Allocation": 0.036432,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 12,
- "Allocation": 0.06182,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 16,
- "Allocation": 0.082029,
- "CustodyAccountId": 2
}, - {
- "InstrumentId": 17,
- "Allocation": 0.052115,
- "CustodyAccountId": 2
}
]
}
Optimizes an existing implemented portfolio.
The User can, optionally, specify the allocation set; if not passed then the latest securities held in the portfolio will be used for the optimization.
A number of additional attributes can be passed to configure the desired optimization such as the Optimization Mode (e.g. MeanVariance), the Optimal Selection Mode (e.g. MaxSharpeRatio), the RiskFreeRate and the Constraints.
In addition, the User can select whether the portfolio should be rebalanced to the optimal allocation or a proposal should be generated for the relevant contacts.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to be optimized. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Securities required | Array of integers <int32> |
OptimizationMode required | string (OptimizationMode) Enum: "MeanVariance" "BlackLitterman" |
Years | integer <int32> Nullable |
OptimalAllocationMode | string (OptimalAllocationMode) Enum: "MaxSharpeRatio" "MinSharpeRatio" "MaxReturn" "MinReturn" "MaxVolatility" "MinVolatility" "MidVolatility" |
RiskFreeRate | number <double> Nullable |
Constraints | string (OptimizationConstraintsType) Enum: "Contact" "Product" "Model" |
CreateProposal required | boolean |
ProjectedExpectedReturns | Array of objects (ProjectedExpectedReturn) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Securities": [
- 5,
- 6,
- 7
], - "OptimizationMode": "MeanVariance",
- "Years": 10,
- "OptimalAllocationMode": "MidVolatility",
- "RiskFreeRate": 0,
- "Constraints": "Product",
- "CreateProposal": true,
- "ProjectedExpectedReturns": [
- {
- "SecurityId": 5,
- "Return": 0.0023
}, - {
- "SecurityId": 6,
- "Return": 0.0014
}
]
}
{- "OptimalAllocationResult": {
- "ExpectedReturn": 0,
- "ExpectedRisk": 0,
- "SharpeRatio": 0,
- "Allocations": [
- {
- "Id": 0,
- "Allocation": 0
}
], - "CalculationKpis": {
- "FromDate": "string",
- "ToDate": "string",
- "DataPoints": 0
}
}, - "PortfolioOperationResult": {
- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [
- "string"
], - "PortfolioId": 0,
- "PortfolioChangeId": 0,
- "Result": "Created"
}
}, - "PortfolioProposalId": 0
}
Adds a specific amount to a theme (i.e. a security of type Core / Satellite) of a portfolio. Doesn't trigger a cash transaction from an external account to the portfolio's cash account. Instead cash is moved from the portfolio's cash account to the custody account by issuing buy order(s) for the theme in question. The new amount is distributed amongst the securities associated with the theme according to either the respective security component allocations or the actual portfolio allocations (depending on the configuration of the AllowDriftingInvestments flag of the respective Product. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to top up |
themeId required | integer <int32> The ID of the theme to top up |
topUpAmount required | number <double> The amount to add to the portfolio in portfolio currency. Must be > 0. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Reduces a specific amount from theme (i.e. a security of type Core / Satellite) of a portfolio. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell order(s) for the theme in question. The amount is reduced amongst the securities associated with the theme according to either the respective security component allocations or the actual portfolio allocations (depending on the configuration of the AllowDriftingInvestments flag of the respective Product).
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to sell from |
themeId required | integer <int32> The ID of the theme to sell from |
amount required | number <double> The amount to sell from the portfolio in portfolio currency. Must be > 0. |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Liquidate a whole theme from a portfolio. Doesn't trigger a cash transaction from the portfolio's cash account to an external account. Instead cash is moved from the portfolio's custody account to the cash account by issuing sell orders. The change will not become effective immediately, only after the order was executed successfully. The execution time of the order is determined by system configuration.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to sell |
themeId required | integer <int32> The ID of the theme to liquidate |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Rebalances an existing theme in a portfolio. The underlying positions of the portfolio associated with the theme in question are rebalanced to the allocations defined in the security components of the theme.
contactId required | integer <int32> The ID of the contact that has access to the portfolio |
portfolioId required | integer <int32> The ID of the portfolio to rebalance |
themeId required | integer <int32> The ID of the theme to rebalance |
forceOrderGeneration | boolean Default: false If set to 'true' forces the generation of order book entries, regardless of the value for the product setting 'IsOrderBookEnabled'. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "OperationResult": "Success",
- "OrderResult": {
- "Messages": [ ],
- "PortfolioId": 1,
- "PortfolioChangeId": 1234,
- "Result": "Created"
}
}
Get the performance attribution of a portfolio vs. a model portfolio. Note that:
- if a currencyId is not passed then the currency of the portfolio will be taken as the default.
- if a modelPortfolioId is not passed then the TAA (i.e. Tactical Model Portfolio) associated with the portfolio will be taken as the default (if available).
- if a FromDate / ToDate are not passed then all available data will be returned
contactId required | integer <int32> The id of the contact that has access to the portfolio |
portfolioId required | integer <int32> The id of the portfolio |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request parameters
CurrencyId | integer <int32> Nullable |
ModelPortfolioId | integer <int32> Nullable |
FromDate | string <date-time> Nullable |
ToDate | string <date-time> Nullable |
AggregationLevel | string (PortfolioManagement.Abstractions.PerformanceAttribution.GetPortfolioPerformanceAttributionCumulative.AggregationLevel) Enum: "AssetClass" "Sector" "Currency" |
Effect | string (PortfolioManagement.Abstractions.PerformanceAttribution.GetPortfolioPerformanceAttributionCumulative.Effect) Enum: "TotalValueAdded" "AssetAllocationEffect" "StockSelectionEffect" "InteractionEffect" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyId": 0,
- "ModelPortfolioId": 0,
- "FromDate": "2024-12-18T16:13:43Z",
- "ToDate": "2024-12-18T16:13:43Z",
- "AggregationLevel": "AssetClass",
- "Effect": "TotalValueAdded"
}
{- "ReferenceCurrency": {
- "Id": 0,
- "UId": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}, - "Portfolio": {
- "Id": 0,
- "Name": "string"
}, - "ModelPortfolio": {
- "Id": 0,
- "Name": "string"
}, - "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Effect": 0,
- "CumEffect": 0
}
], - "Error": 0
}
Get the performance attribution of a portfolio vs. a model portfolio. Note that:
- if a currencyId is not passed then the currency of the portfolio will be taken as the default.
- if a modelPortfolioId is not passed then the TAA (i.e. Tactical Model Portfolio) associated with the portfolio will be taken as the default (if available).
- if a FromDate / ToDate are not passed then all available data will be returned
contactId required | integer <int32> The id of the contact that has access to the portfolio |
portfolioId required | integer <int32> The id of the portfolio |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request parameters
CurrencyId | integer <int32> Nullable |
ModelPortfolioId | integer <int32> Nullable |
FromDate | string <date-time> Nullable |
ToDate | string <date-time> Nullable |
AggregationLevel | string (PortfolioManagement.Abstractions.PerformanceAttribution.GetPortfolioPerformanceAttributionDetails.AggregationLevel) Enum: "AssetClass" "Sector" "Currency" |
Effect | string (PortfolioManagement.Abstractions.PerformanceAttribution.GetPortfolioPerformanceAttributionDetails.Effect) Enum: "TotalValueAdded" "AssetAllocationEffect" "StockSelectionEffect" "InteractionEffect" |
Mode | string (PortfolioManagement.Abstractions.PerformanceAttribution.GetPortfolioPerformanceAttributionDetails.Mode) Enum: "Details" "Summary" |
ExposureId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "CurrencyId": 0,
- "ModelPortfolioId": 0,
- "FromDate": "2024-12-18T16:13:43Z",
- "ToDate": "2024-12-18T16:13:43Z",
- "AggregationLevel": "AssetClass",
- "Effect": "TotalValueAdded",
- "Mode": "Details",
- "ExposureId": 0
}
{- "Values": [
- {
- "Date": "2024-12-18T16:13:43Z",
- "Items": [
- {
- "ExposureId": 0,
- "ExposureName": "string",
- "AllocationPortfolio": 0,
- "AllocationModelPortfolio": 0,
- "PerformancePortfolio": 0,
- "PerformanceModelPortfolio": 0,
- "IndividualAllocationEffect": 0,
- "IndividualAllocationCumEffect": 0,
- "IndividualSelectionEffect": 0,
- "IndividualSelectionCumEffect": 0,
- "IndividualInteractionEffect": 0,
- "IndividualInteractionCumEffect": 0,
- "IndividualTotalValueAdded": 0,
- "IndividualTotalValueAddedCum": 0
}
]
}
]
}
Searches for portfolios and returns a list with portfolios (and key attributes) matching the passed request parameters.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Search | string Nullable |
Ids | Array of integers <int32> Nullable |
ExternalId | string Nullable |
Name | string Nullable |
AdvisorIds | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable |
TypeIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
StatusIds | Array of integers <int32> Nullable |
ModelPortfolioIds | Array of integers <int32> Nullable |
PortfolioProposalIds | Array of integers <int32> Nullable |
IsBreached | boolean Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Search": "string",
- "Ids": [
- 0
], - "ExternalId": "string",
- "Name": "string",
- "AdvisorIds": [
- 0
], - "ContactIds": [
- 0
], - "ProductOfferIds": [
- 0
], - "ProductIds": [
- 0
], - "CurrencyIds": [
- 0
], - "TypeIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "StatusIds": [
- 0
], - "ModelPortfolioIds": [
- 0
], - "PortfolioProposalIds": [
- 0
], - "IsBreached": true,
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "ExternalId": "string",
- "ContactGroupId": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "FirstInvestmentDate": "2024-12-18T16:13:43Z",
- "Risk": 0,
- "Return": 0,
- "Performance": 0,
- "PerformanceDate": "2024-12-18T16:13:43Z",
- "CurrentValue": 0,
- "ModelPortfolio": {
- "Id": 0,
- "Name": "string",
- "UId": "string"
}, - "PortfolioProposalId": {
- "Id": 0,
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}, - "ProductOffer": {
- "Id": 0,
- "Name": "string",
- "UId": "string"
}, - "Product": {
- "Id": 0,
- "Name": "string",
- "UId": "string",
- "ProductType": {
- "Id": 0,
- "Name": "string"
}
}, - "Status": {
- "Key": "NotImplemented",
- "Name": "string",
- "Id": 0
}, - "Type": {
- "Key": "Real",
- "Name": "string",
- "Id": 0
}, - "IntegrationStatus": {
- "Id": 0,
- "Name": "string"
}, - "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string",
- "UId": "string"
}, - "RebalancingType": {
- "Key": "NoRebalancing",
- "Name": "string",
- "Id": 0
}, - "ParentId": 0,
- "IsBreached": true,
- "OptimizationConstraintId": 0,
- "BenchmarkId": 0
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for proposals and returns a list with proposals (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (Name, Portfolio.ExternalId, Currency.CurrencyCode) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
PortfolioIds | Array of integers <int32> Nullable |
ContactGroupIds | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
PortfolioExternalId | string Nullable |
Ids | Array of integers <int32> Nullable |
Name | string Nullable |
AdvisorIds | Array of integers <int32> Nullable |
StatusIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
ModelPortfolioIds | Array of integers <int32> Nullable |
CurrencyIds | Array of integers <int32> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioIds": [
- 0
], - "ContactGroupIds": [
- 0
], - "ContactIds": [
- 0
], - "PortfolioExternalId": "string",
- "Ids": [
- 0
], - "Name": "string",
- "AdvisorIds": [
- 0
], - "StatusIds": [
- 0
], - "ProductIds": [
- 0
], - "ModelPortfolioIds": [
- 0
], - "CurrencyIds": [
- 0
], - "CreateDateFrom": "2024-12-18T16:13:43Z",
- "CreateDateTo": "2024-12-18T16:13:43Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "Name": "string",
- "ContactGroupId": 0,
- "AdvisorId": 0,
- "AdvisorName": "string",
- "OptimizationConstraintId": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "Risk": 0,
- "Return": 0,
- "ModelPortfolio": {
- "Id": 0,
- "Name": "string",
- "UId": "string"
}, - "RecommendedAmount": 0,
- "BenchmarkId": 0,
- "Portfolio": {
- "Id": 0,
- "ExternalId": "string",
- "Name": "string",
- "UId": "string"
}, - "ProductOffer": {
- "Id": 0,
- "Name": "string",
- "UId": "string"
}, - "Product": {
- "Id": 0,
- "Name": "string",
- "UId": "string",
- "ProductType": {
- "Id": 0,
- "Name": "string"
}
}, - "Status": {
- "Key": "Created",
- "Name": "string",
- "Id": 0
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for switch suggestions and returns a list with switch suggestions (and key attributes) matching the passed request parameters.
The ValidUntil date includes all switch suggestion valid until that date, including the date. The time part is ignored.
Sorting can be performed by specifying any property name or child property name using navigation (Name, Portfolio.ExternalId, Currency.CurrencyCode) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
ContactIds | Array of integers <int32> Nullable |
Ids | Array of integers <int32> Nullable |
PortfolioIds | Array of integers <int32> Nullable |
PortfolioExternalId | string Nullable |
AdvisorIds | Array of integers <int32> Nullable |
Statuses | Array of strings (SwitchSuggestionStatus) Nullable Items Enum: "Accepted" "Rejected" "AwaitingFeedback" |
ValidUntil | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ContactIds": [
- 0
], - "Ids": [
- 0
], - "PortfolioIds": [
- 0
], - "PortfolioExternalId": "string",
- "AdvisorIds": [
- 0
], - "Statuses": [
- "Accepted"
], - "ValidUntil": "2024-12-18T16:13:43Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "UId": "string",
- "Portfolio": {
- "Id": 0,
- "ExternalId": "string",
- "Name": "string",
- "UId": "string"
}, - "ContactGroupId": 0,
- "InteractionId": 0,
- "IsAccepted": true,
- "AdvisorId": 0,
- "AdvisorName": "string",
- "CreateDate": "2024-12-18T16:13:43Z",
- "ValidUntil": "2024-12-18T16:13:43Z"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for model portfolios and returns a list with model portfolios (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (Name, Portfolio.ExternalId, Currency.CurrencyCode) in SortBy property in the request. This API is deprecated. Use POST /v1.1/model-portfolios/search instead.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Ids | Array of integers <int32> Nullable |
Name | string Nullable |
TypeIds | Array of integers <int32> Nullable |
AdvisorIds | Array of integers <int32> Nullable |
OptimizationTypeIds | Array of integers <int32> Nullable |
AllocationTypeIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
RiskCategoryDefinitionIds | Array of integers <int32> Nullable |
DerivedFromModelPortfolioIds | Array of integers <int32> Nullable |
DerivedFromModelPortfolioName | string Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
ExternalId | string Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "Name": "string",
- "TypeIds": [
- 0
], - "AdvisorIds": [
- 0
], - "OptimizationTypeIds": [
- 0
], - "AllocationTypeIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "RiskCategoryDefinitionIds": [
- 0
], - "DerivedFromModelPortfolioIds": [
- 0
], - "DerivedFromModelPortfolioName": "string",
- "ProductOfferIds": [
- 0
], - "ProductIds": [
- 0
], - "ExternalId": "string",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "TimeHorizon": 0,
- "AdvisorId": 0,
- "IsActive": true,
- "CreateDate": "2024-12-18T16:13:43Z",
- "UpdateDate": "2024-12-18T16:13:43Z",
- "MinAmount": 0,
- "MaxAmount": 0,
- "ModelType": {
- "Key": "InstrumentBased",
- "Name": "string",
- "Id": 0
}, - "OptimizationType": {
- "Key": "MeanVariance",
- "Name": "string",
- "Id": 0
}, - "AllocationType": {
- "Key": "SaaModel",
- "Name": "string",
- "Id": 0
}, - "DerivedFrom": {
- "Id": 0,
- "Name": "string"
}, - "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string",
- "UId": "string"
}, - "ProductOffer": {
- "Id": 0,
- "Name": "string",
- "UId": "string"
}, - "Product": {
- "Id": 0,
- "Name": "string",
- "UId": "string",
- "ProductType": {
- "Id": 0,
- "Name": "string"
}
}, - "ExternalId": "string"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for model portfolios and returns a list with model portfolios (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (Name, Portfolio.ExternalId, Currency.CurrencyCode) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Ids | Array of integers <int32> Nullable |
Name | string Nullable |
TypeIds | Array of integers <int32> Nullable |
AdvisorIds | Array of integers <int32> Nullable |
OptimizationTypeIds | Array of integers <int32> Nullable |
AllocationTypeIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
RiskCategoryDefinitionIds | Array of integers <int32> Nullable |
DerivedFromModelPortfolioIds | Array of integers <int32> Nullable |
DerivedFromModelPortfolioName | string Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
ExternalId | string Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "Name": "string",
- "TypeIds": [
- 0
], - "AdvisorIds": [
- 0
], - "OptimizationTypeIds": [
- 0
], - "AllocationTypeIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "RiskCategoryDefinitionIds": [
- 0
], - "DerivedFromModelPortfolioIds": [
- 0
], - "DerivedFromModelPortfolioName": "string",
- "ProductOfferIds": [
- 0
], - "ProductIds": [
- 0
], - "ExternalId": "string",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "TimeHorizon": 0,
- "AdvisorId": 0,
- "IsActive": true,
- "CreateDate": "2024-12-18T16:13:43Z",
- "UpdateDate": "2024-12-18T16:13:43Z",
- "MinAmount": 0,
- "MaxAmount": 0,
- "ModelType": {
- "Key": "InstrumentBased",
- "Name": "string",
- "Id": 0
}, - "OptimizationType": {
- "Key": "MeanVariance",
- "Name": "string",
- "Id": 0
}, - "AllocationType": {
- "Key": "SaaModel",
- "Name": "string",
- "Id": 0
}, - "DerivedFrom": {
- "Id": 0,
- "Name": "string"
}, - "RiskCategory": {
- "Id": 0,
- "Name": "string",
- "ExternalId": "string",
- "UId": "string"
}, - "ExternalId": "string"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for orders and returns a list with orders (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (PortfolioChangeId, LimitPrice, ExternalId) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Ids | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
PortfolioName | string Nullable |
PortfolioExternalId | string Nullable |
PortfolioIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
CustodyAccountIds | Array of integers <int32> Nullable |
FundingAccountIds | Array of integers <int32> Nullable |
PortfolioChangeIds | Array of integers <int32> Nullable |
PortfolioChangeTypeIds | Array of integers <int32> Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
ModelPortfolioIds | Array of integers <int32> Nullable |
PortfolioProposalIds | Array of integers <int32> Nullable |
SecurityName | string Nullable |
SecurityIsin | string Nullable |
SecurityIds | Array of integers <int32> Nullable |
StockExchangeIds | Array of integers <int32> Nullable |
StockExchangeOrderTypeIds | Array of integers <int32> Nullable |
StockExchangeOrderValidityIds | Array of integers <int32> Nullable |
BlockOrderIds | Array of integers <int32> Nullable |
OrderTypeIds | Array of integers <int32> Nullable |
StatusIds | Array of integers <int32> Nullable |
TradingCurrencyIds | Array of integers <int32> Nullable |
IntegrationStatusIds | Array of integers <int32> Nullable |
ExternalId | string Nullable |
AccountTransactionId | integer <int32> Nullable |
ValidityDateFrom | string <date-time> Nullable |
ValidityDateTo | string <date-time> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
ReleaseDateFrom | string <date-time> Nullable |
ReleaseDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "ContactIds": [
- 0
], - "PortfolioName": "string",
- "PortfolioExternalId": "string",
- "PortfolioIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "CustodyAccountIds": [
- 0
], - "FundingAccountIds": [
- 0
], - "PortfolioChangeIds": [
- 0
], - "PortfolioChangeTypeIds": [
- 0
], - "ProductOfferIds": [
- 0
], - "ProductIds": [
- 0
], - "ModelPortfolioIds": [
- 0
], - "PortfolioProposalIds": [
- 0
], - "SecurityName": "string",
- "SecurityIsin": "string",
- "SecurityIds": [
- 0
], - "StockExchangeIds": [
- 0
], - "StockExchangeOrderTypeIds": [
- 0
], - "StockExchangeOrderValidityIds": [
- 0
], - "BlockOrderIds": [
- 0
], - "OrderTypeIds": [
- 0
], - "StatusIds": [
- 0
], - "TradingCurrencyIds": [
- 0
], - "IntegrationStatusIds": [
- 0
], - "ExternalId": "string",
- "AccountTransactionId": 0,
- "ValidityDateFrom": "2024-12-18T16:13:43Z",
- "ValidityDateTo": "2024-12-18T16:13:43Z",
- "CreateDateFrom": "2024-12-18T16:13:43Z",
- "CreateDateTo": "2024-12-18T16:13:43Z",
- "ReleaseDateFrom": "2024-12-18T16:13:43Z",
- "ReleaseDateTo": "2024-12-18T16:13:43Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "PortfolioChangeId": 0,
- "PortfolioChangeTypeId": 0,
- "SecurityId": 0,
- "Quantity": 0,
- "Price": 0,
- "LimitPrice": 0,
- "StopPrice": 0,
- "AmountAccountCurrency": 0,
- "AmountSecurityCurrency": 0,
- "FxRate": 0,
- "StockExchangeId": 0,
- "StockExchangeOrderTypeId": 0,
- "StockExchangeOrderValidityId": 0,
- "OrderBookStatusId": 0,
- "ValidityDate": "2024-12-18T16:13:43Z",
- "CreateDate": "2024-12-18T16:13:43Z",
- "ReleaseDate": "2024-12-18T16:13:43Z",
- "PortfolioId": 0,
- "ProductId": 0,
- "CustodyAccountId": 0,
- "FundingAccountId": 0,
- "OrderTypeId": 0,
- "BlockOrderId": 0,
- "OrderBookIntegrationStatusId": 0,
- "ExternalId": "string",
- "AccountTransactionId": 0,
- "TradingCurrencyId": 0,
- "CustodyParticipantUid": "string",
- "CounterpartyParticipantUid": "string"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for block orders and returns a list with block orders (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name or child property name using navigation (PortfolioChangeId, LimitPrice, ExternalId) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Ids | Array of integers <int32> Nullable |
SecurityName | string Nullable |
SecurityIsin | string Nullable |
SecurityIds | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
PortfolioName | string Nullable |
PortfolioExternalId | string Nullable |
PortfolioIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
ModelPortfolioIds | Array of integers <int32> Nullable |
PortfolioProposalIds | Array of integers <int32> Nullable |
StockExchangeIds | Array of integers <int32> Nullable |
StockExchangeOrderTypeIds | Array of integers <int32> Nullable |
StockExchangeOrderValidityIds | Array of integers <int32> Nullable |
OrderTypeIds | Array of integers <int32> Nullable |
StatusIds | Array of integers <int32> Nullable |
IntegrationStatusIds | Array of integers <int32> Nullable |
ExternalId | string Nullable |
ValidityDateFrom | string <date-time> Nullable |
ValidityDateTo | string <date-time> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
ReleaseDateFrom | string <date-time> Nullable |
ReleaseDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "SecurityName": "string",
- "SecurityIsin": "string",
- "SecurityIds": [
- 0
], - "ContactIds": [
- 0
], - "PortfolioName": "string",
- "PortfolioExternalId": "string",
- "PortfolioIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "ProductOfferIds": [
- 0
], - "ProductIds": [
- 0
], - "ModelPortfolioIds": [
- 0
], - "PortfolioProposalIds": [
- 0
], - "StockExchangeIds": [
- 0
], - "StockExchangeOrderTypeIds": [
- 0
], - "StockExchangeOrderValidityIds": [
- 0
], - "OrderTypeIds": [
- 0
], - "StatusIds": [
- 0
], - "IntegrationStatusIds": [
- 0
], - "ExternalId": "string",
- "ValidityDateFrom": "2024-12-18T16:13:43Z",
- "ValidityDateTo": "2024-12-18T16:13:43Z",
- "CreateDateFrom": "2024-12-18T16:13:43Z",
- "CreateDateTo": "2024-12-18T16:13:43Z",
- "ReleaseDateFrom": "2024-12-18T16:13:43Z",
- "ReleaseDateTo": "2024-12-18T16:13:43Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "ProductId": 0,
- "SecurityId": 0,
- "ExternalId": "string",
- "Quantity": 0,
- "ValidityDate": "2024-12-18T16:13:43Z",
- "CreateDate": "2024-12-18T16:13:43Z",
- "ReleaseDate": "2024-12-18T16:13:43Z",
- "OrderTypeId": 0,
- "OrderBookStatusId": 0,
- "StockExchangeId": 0,
- "StockExchangeOrderTypeId": 0,
- "StockExchangeOrderValidityId": 0,
- "OrderBookIntegrationStatusId": 0,
- "CustodyParticipantUid": "string",
- "CounterpartyParticipantUid": "string"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for portfolio changes and returns a list with portfolio changes (and key attributes) matching the passed request parameters.
Sorting can be performed by specifying any property name (no child property name in this case) in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
Ids | Array of integers <int32> Nullable |
PortfolioIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
ModelPortfolioIds | Array of integers <int32> Nullable |
LinkedPortfolioChangeIds | Array of integers <int32> Nullable |
PortfolioChangeTypeIds | Array of integers <int32> Nullable |
PortfolioProposalIds | Array of integers <int32> Nullable |
PortfolioChangeAvailabilityIds | Array of integers <int32> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "PortfolioIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "ModelPortfolioIds": [
- 0
], - "LinkedPortfolioChangeIds": [
- 0
], - "PortfolioChangeTypeIds": [
- 0
], - "PortfolioProposalIds": [
- 0
], - "PortfolioChangeAvailabilityIds": [
- 0
], - "CreateDateFrom": "2024-12-18T16:13:43Z",
- "CreateDateTo": "2024-12-18T16:13:43Z",
- "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "PortfolioId": 0,
- "ContactGroupId": 0,
- "RiskCategoryId": 0,
- "ModelPortfolioId": 0,
- "LinkedPortfolioChangeId": 0,
- "PortfolioChangeTypeId": 0,
- "PortfolioProposalId": 0,
- "PortfolioChangeAvailabilityId": 0,
- "CreateDate": "2024-12-18T16:13:43Z",
- "Details": [
- {
- "Id": 0,
- "SecurityId": 0,
- "Allocation": 0,
- "Amount": 0,
- "Quantity": 0,
- "StockExchangeOrderTypeId": 0,
- "LimitPrice": 0,
- "StopPrice": 0,
- "ValidityDate": "2024-12-18T16:13:43Z",
- "StockExchangeOrderValidityId": 0,
- "ExternalOrderId": "string",
- "PortfolioChangeStatusId": 0,
- "CustodyAccountId": 0,
- "FundingAccountId": 0,
- "StockExchangeId": 0
}
]
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for portfolios with orders in reconciliation status and returns a list of portfolios (and related order information) matching the passed request parameters.
Sorting can be performed by specifying any property name in SortBy property in the request.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
PortfolioIds | Array of integers <int32> Nullable |
PortfolioName | string Nullable |
PortfolioExternalId | string Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
ProductIds | Array of integers <int32> Nullable |
PortfolioChangeTypeIds | Array of integers <int32> Nullable |
RiskCategoryIds | Array of integers <int32> Nullable |
ModelPortfolioIds | Array of integers <int32> Nullable |
PortfolioProposalIds | Array of integers <int32> Nullable |
ContactIds | Array of integers <int32> Nullable |
AdvisorIds | Array of integers <int32> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioIds": [
- 0
], - "PortfolioName": "string",
- "PortfolioExternalId": "string",
- "ProductOfferIds": [
- 0
], - "ProductIds": [
- 0
], - "PortfolioChangeTypeIds": [
- 0
], - "RiskCategoryIds": [
- 0
], - "ModelPortfolioIds": [
- 0
], - "PortfolioProposalIds": [
- 0
], - "ContactIds": [
- 0
], - "AdvisorIds": [
- 0
], - "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "ExternalId": "string",
- "ContactGroupId": 0,
- "CurrencyId": 0,
- "ProductOfferId": 0,
- "ProductId": 0,
- "PortfolioChangeTypeId": 0,
- "PortfolioChangeId": 0,
- "ValidationStatus": "OK",
- "CurrentSecuritiesBalance": 0,
- "CurrentLiquidityBalance": 0,
- "TargetSecuritiesBalance": 0,
- "TargetLiquidityBalance": 0,
- "CreateDate": "2024-12-18T16:13:43Z"
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Releases orders from the pre-orderbook to the orderbook (i.e. status changed from Reconciliation to Generated).
Either releaseAllOrders or orderBookIds or portfolioIds can be specified, but not at the same time.
If releaseAllOrders=true, all orders in status Reconciliation are moved to Generated. This API is deprecated. Use POST /v1.1/contacts/portfolios/pre-orderbook/release instead.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
PortfolioIds | Array of integers <int32> Nullable |
OrderBookIds | Array of integers <int32> Nullable |
ReleaseAllOrders | boolean Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReleaseAllOrders": true
}
{- "UpdatedOrderBooksFromPortfolioIds": [
- 0
], - "UpdatedOrderBookIds": [
- 0
]
}
Triggers a long-running request to release orders from the pre-orderbook to the orderbook (i.e. status changed from Reconciliation to Generated).
Either releaseAllOrders or orderBookIds or portfolioIds can be specified, but not at the same time.
If releaseAllOrders=true, all orders in status Reconciliation are moved to Generated.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
PortfolioIds | Array of integers <int32> Nullable |
OrderBookIds | Array of integers <int32> Nullable |
ReleaseAllOrders | boolean Nullable |
OK
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReleaseAllOrders": true
}
{- "LongRunningRequestId": "string"
}
Imports a CSV file containing the instruments / allocations for a number of model portfolios. Note that existing instruments / allocations for the passed model portfolios are completely overwritten with the instruments / allocations passed in the file.
simulate | boolean Default: false If True the endpoint will only validate the passed CSV, without committing the changes. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
file | string <binary> The csv file containing instruments and allocations of model portfolios |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Imports a CSV file containing the constraints for a number of model portfolios. Note that existing constraints for the passed model portfolios are completely overwritten with the constraints passed in the file.
Following are the supported constraints with the corresponding attribute for the ConstraintExternalId
ConstraintType | ConstraintExternalId
Sector = SecuritySector.ExternalId
SecurityType = SecurityType.ExternalId
AssetClass = AssetClass.ExternalId
EconomicalZone = EconomicalZone.Name
Country = Country.ThreeLetterIsoCode
Continent = Continent.Name
Currency = Currency.ThreeLetterIsoCode
Security = Security.ExternalId
simulate | boolean Default: false If True the endpoint will only validate the passed CSV, without committing the changes. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
file | string <binary> The csv file containing constraints of model portfolios |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Imports a CSV file containing the fees for a number of model portfolios. Note that existing fees for the passed model portfolios are completely overwritten with the fees passed in the file.
simulate | boolean Default: false If True the endpoint will only validate the passed CSV, without committing the changes. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
file | string <binary> The csv file containing fees of model portfolios |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Imports a CSV file containing the metadata for a number of model portfolios. Note that only the metadatas passed in the file will be updated for the relevant model portfolios; not passed metadatas will remain untouched.
simulate | boolean Default: false If True the endpoint will only validate the passed CSV, without committing the changes. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
file | string <binary> The csv file containing metadata of model portfolios |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Validates an instrument set against the associated constraints. The following combinations are possible:
PortfolioId: validate whether the current allocations of a Portfolio are breaching any constraints
PortfolioId and InstrumentAllocations: validate whether the target (i.e. new) instrument set of a Portfolio are breaching any constraints
InstrumentAllocations, ProductId, RiskCategoryId and ContactId: validate whether the target instrument set passed is breaching the constraints
Note the following constraints are checked: Model Portfolio, Portfolio Proposal, Risk Category, Product, Contact.
includeLookThrough required | boolean Determines whether security look-through should be accounted |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request parameters
PortfolioId | integer <int32> Nullable |
InstrumentAllocations | Array of objects (PortfolioManagement.Abstractions.OptimizationConstraints.ValidateConstraints.InstrumentAllocation) Nullable |
ProductId | integer <int32> Nullable |
RiskCategoryId | integer <int32> Nullable |
ContactId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PortfolioId": 0,
- "InstrumentAllocations": [
- {
- "InstrumentId": 0,
- "Allocation": 0
}
], - "ProductId": 0,
- "RiskCategoryId": 0,
- "ContactId": 0
}
{- "IsBreached": true,
- "BreachSources": {
- "Portfolio": {
- "Id": 0,
- "OptimizationConstraintId": 0,
- "Breaches": [
- {
- "BreachTypeKey": "AssetClass",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "MinWeight": 0,
- "MaxWeight": 0,
- "Allocation": 0
}
]
}, - "ModelPortfolio": {
- "Id": 0,
- "OptimizationConstraintId": 0,
- "Breaches": [
- {
- "BreachTypeKey": "AssetClass",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "MinWeight": 0,
- "MaxWeight": 0,
- "Allocation": 0
}
]
}, - "PortfolioProposal": {
- "Id": 0,
- "OptimizationConstraintId": 0,
- "Breaches": [
- {
- "BreachTypeKey": "AssetClass",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "MinWeight": 0,
- "MaxWeight": 0,
- "Allocation": 0
}
]
}, - "RiskCategory": {
- "Id": 0,
- "OptimizationConstraintId": 0,
- "Breaches": [
- {
- "BreachTypeKey": "AssetClass",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "MinWeight": 0,
- "MaxWeight": 0,
- "Allocation": 0
}
]
}, - "Product": {
- "Id": 0,
- "OptimizationConstraintId": 0,
- "Breaches": [
- {
- "BreachTypeKey": "AssetClass",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "MinWeight": 0,
- "MaxWeight": 0,
- "Allocation": 0
}
]
}, - "Contacts": [
- {
- "Id": 0,
- "OptimizationConstraintId": 0,
- "Breaches": [
- {
- "BreachTypeKey": "AssetClass",
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "MinWeight": 0,
- "MaxWeight": 0,
- "Allocation": 0
}
]
}
]
}
}
Deletes the counterparties associated with the product of a participant
participantId required | integer <int32> The id of the participant. |
productId required | integer <int32> The id of the product assigned to the participant. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Updates the counterparties associated with the product of a participant
participantId required | integer <int32> The id of the participant. |
productId required | integer <int32> The id of the product. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Counterparties | Array of objects (CounterpartySetting) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Counterparties": [
- {
- "CounterpartyId": 0,
- "Settings": "string"
}
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes an existing product.
productId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modifies an existing product.
productId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
ProductOfferId | integer <int32> |
Name | string Nullable |
Description | string Nullable |
Image | string Nullable |
MinimumInvestmentValue | number <double> Nullable |
MaximumInvestmentValue | number <double> Nullable |
ContactType | string (Domain.Abstractions.Enums.ContactType) Enum: "Private" "Corporate" "All" |
IsActive | boolean |
PortfolioRebalancingType | string (PortfolioRebalancingTypeId) Enum: "NoRebalancing" "Manual" "Automatic" |
ExternalId | string Nullable |
DefaultOrderBookStatus | string (OrderBookStatusId) Enum: "Reconciliation" "ToBeProcessed" "Generated" "Released" "Pulled" "Cancelled" "PartiallyExecuted" "Executed" "Error" "ThresholdBreached" "Undelivered" |
IsBlockOrderBookEnabled | boolean |
IsOrderBookEnabled | boolean |
AllowDriftingInvestments | boolean Nullable |
AllowDriftingSells | boolean Nullable |
AllowRebalancingForTopUp | boolean Nullable |
AllowRebalancingForSell | boolean Nullable |
Settings | string Nullable |
ProductType | string (ProductTypeId) Enum: "Advisory" "Discretionary" "ExecutionOnly" "Other" "AssistedDiscretionary" |
Fees | Array of objects (FeeRequest) Nullable |
OptimizationConstraints | object (OptimizationConstraintRequest) |
InstrumentUniverse | Array of integers <int32> Nullable |
Participants | object (ModifyProductParticipantsRequest) |
NationalityCountryUniverse | Array of integers <int32> Nullable |
DomicileCountryUniverse | Array of integers <int32> Nullable |
Factsheet | string Nullable |
FactsheetFilesForUpload | Array of objects (ProductFactsheetFileForUploadRequest) Nullable |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ProductOfferId": 1,
- "Name": "<root><de>Diskretionärmandat</de><en>Discretionary</en><it>Discrezionale</it><fr>Discrétionnaire</fr></root>",
- "Description": "<root><de>Im 'Descretionary Mandate' delegieren sie alle Investitionsentscheidungen in Verbindung mit diesem Portfolio an ihren Anlageberater. Die Investitionen werden anhand ihres Klienten- und Investitionsprofils ausgeführt. Dieses Angebot hat eine jährliche Gebühr von [Fee] und der minimale Investitionsbetrag beträgt [PlatformCurrency] [Min.Investment].</de><en>Discretionary investment management is ideal for those short on time. Your relationship manager creates a tailored investment strategy based on your goals and risk tolerance. They handle investment decisions without needing your approval for each transaction, while updates to your strategy adapt to your changing needs.</en><it>[IT]In the “Discretionary Mandate” you delegate all investment decisions in connection with this portfolio to the asset manager. Investments are made within the limits of the determined client and investment profile. This offering has a [Fee] annual fee and the minimum investment amount is [PlatformCurrency] [Min.Investment].</it><fr>[FR]In the “Discretionary Mandate” you delegate all investment decisions in connection with this portfolio to the asset manager. Investments are made within the limits of the determined client and investment profile. This offering has a [Fee] annual fee and the minimum investment amount is [PlatformCurrency] [Min.Investment].</fr></root>",
- "Image": "fileInBase64",
- "MinimumInvestmentValue": 25000,
- "MaximumInvestmentValue": 1000000,
- "ContactType": "Private",
- "IsActive": true,
- "PortfolioRebalancingType": "NoRebalancing",
- "ExternalId": "SJDHGHS",
- "DefaultOrderBookStatus": "Reconciliation",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "AllowDriftingInvestments": true,
- "AllowDriftingSells": true,
- "AllowRebalancingForTopUp": true,
- "AllowRebalancingForSell": true,
- "Settings": "string",
- "ProductType": "Discretionary",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": false,
- "ValidFrom": "2024-08-05T00:00:00",
- "ValidTo": "2025-08-05T00:00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 4,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 10,
- "ValueTo": 20,
- "FeeValue": 3
}
]
}
], - "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "InstrumentUniverse": [
- 1,
- 2,
- 3,
- 4,
- 5
], - "Participants": {
- "ParticipantsInformation": [
- {
- "ParticipantUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "RoleTypeKey": "Custody"
}
], - "Counterparties": [
- {
- "ParticipantUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "CounterpartyParticipantUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "Settings": "string"
}
]
}, - "NationalityCountryUniverse": [
- 1
], - "DomicileCountryUniverse": [
- 2
], - "Factsheet": "<root><en /></root>",
- "FactsheetFilesForUpload": [
- {
- "LanguageTwoLetterIsoCode": "fr",
- "FileData": "JVBERi0xLjYKJdP0zOEKNSAwIG9iago8PAovVHlwZS9QYWdlCi9NZWRpYUJveFswIDAgODQxLjg5IDU5NS4yNzZdCi9Hcm91cAo8PAovVHlwZS9Hcm91",
- "FileName": "TestPdf",
- "OldFileExternalId": 0,
- "ToDeleteOldFile": false
}
], - "UpdateProperties": [
- "ProductOfferId",
- "Name",
- "Description",
- "Image",
- "MinimumInvestmentValue",
- "MaximumInvestmentValue",
- "ContactType",
- "IsActive",
- "PortfolioRebalancingType",
- "ExternalId",
- "DefaultOrderBookStatus",
- "IsOrderBookEnabled",
- "IsBlockOrderBookEnabled",
- "AllowDriftingInvestments",
- "AllowDriftingSells",
- "AllowRebalancingForSell",
- "AllowRebalancingForTopUp",
- "Settings",
- "ProductType",
- "Fees",
- "OptimizationConstraints",
- "InstrumentUniverse",
- "Participants",
- "Factsheet",
- "FactsheetFilesForUpload",
- "DomicileCountryUniverse",
- "NationalityCountryUniverse"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes a risk category definition for an existing product.
productId required | integer <int32> |
riskCategoryId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Modify a risk category definition for an existing product.
productId required | integer <int32> |
riskCategoryId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
RiskCategoryId | integer <int32> |
Description | string Nullable |
Min | number <double> |
Max | number <double> |
IsActive | boolean |
ExpectedReturn | number <double> Nullable |
Color | string Nullable |
Attributes | string Nullable |
ValidMonth | integer <int32> Nullable |
OptimizationConstraints | object (OptimizationConstraintRequest) |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RiskCategoryId": 1,
- "Description": "<root><de>TestDescription</de><en>TestDescription</en></root>",
- "Min": 0.05,
- "Max": 0.125,
- "IsActive": true,
- "ExpectedReturn": 0.057,
- "Color": "#000000",
- "Attributes": "{CustomSettings : []}",
- "ValidMonth": 12,
- "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "UpdateProperties": [
- "RiskCategoryId",
- "Description",
- "Min",
- "Max",
- "ExpectedReturn",
- "Color",
- "IsActive",
- "Attributes",
- "ValidMonth",
- "OptimizationConstraints"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes an existing product offer.
productOfferId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets the details of a product offer.
productOfferId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string",
- "CreateDate": "2024-12-18T16:13:43Z",
- "Picture": "string",
- "IsActive": true,
- "ProductOfferType": {
- "Id": 0,
- "Name": "string"
}, - "ExternalId": "string",
- "UId": "string",
- "Currencies": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
]
}
Modifies an existing product offer.
productOfferId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Name | string Nullable |
IsActive | boolean |
TypeId | integer <int32> |
CampaignId | integer <int32> |
Description | string Nullable |
Image | string Nullable |
ExternalId | string Nullable |
Factsheet | string Nullable |
FactsheetFilesForUpload | Array of objects (ProductFactsheetFileForUploadRequest) Nullable |
Currencies | Array of integers <int32> Nullable |
UpdateProperties | Array of strings Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "<root><en>Wealth Offering</en><de>Wealth Offering</de><it>Wealth Offering</it><fr>Wealth Offering</fr></root>",
- "IsActive": true,
- "TypeId": 1,
- "CampaignId": 1,
- "Description": "<root><de /><en>Our Wealth Offering gives you independence and flexibility when managing your finances. You can carry out your banking transactions conveniently, anywhere and at any time. A secure login gets you quickly to all the details of your finances, and provides access to a wide range of functions. Investment decision and discussion are still executed at your local branch with your personal advisor.</en><it /><fr /></root>",
- "Image": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNDZweCIgaGVpZ2h0PSI0OXB4IiB2aWV3Qm94PSIwIDAgNDYgNDkiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayI+CiAgICA8dGl0bGU+M0ZEQkE2ODEtQTQxQy00RThDLTkwOEUtOTE5RjNCQjlCNUQwPC90aXRsZT4KICAgIDxnIGlkPSJXSVAiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCI+CiAgICAgICAgPGcgaWQ9IldpemFyZC0tT2ZmZXJpbmciIHRyYW5zZm9ybT0idHJhbnNsYXRlKC0yMDYuMDAwMDAwLCAtMjg2LjAwMDAwMCkiIHN0cm9rZT0iIzI4MjcyNiIgc3Ryb2tlLXdpZHRoPSIyIj4KICAgICAgICAgICAgPGcgaWQ9Ikdyb3VwLTUiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQwLjAwMDAwMCwgNDAuMDAwMDAwKSI+CiAgICAgICAgICAgICAgICA8ZyBpZD0iR3JvdXAtMiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTIxLjAwMDAwMCwgMjM1LjAwMDAwMCkiPgogICAgICAgICAgICAgICAgICAgIDxnIGlkPSJvZmZpY2lhbC1idWlsZGluZy0zIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSg0Ni4wMDAwMDAsIDEyLjAwMDAwMCkiPgogICAgICAgICAgICAgICAgICAgICAgICA8cmVjdCBpZD0iUmVjdGFuZ2xlIiB4PSI2LjI4NTI2MTg0IiB5PSIxNS41MjYxNDcyIiB3aWR0aD0iNi4yODUyNjE4NCIgaGVpZ2h0PSIxOC44NTU3ODU1Ij48L3JlY3Q+CiAgICAgICAgICAgICAgICAgICAgICAgIDxyZWN0IGlkPSJSZWN0YW5nbGUiIHg9IjE4Ljg1NTc4NTUiIHk9IjE1LjUyNjE0NzIiIHdpZHRoPSI2LjI4NTI2MTg0IiBoZWlnaHQ9IjE4Ljg1NTc4NTUiPjwvcmVjdD4KICAgICAgICAgICAgICAgICAgICAgICAgPHJlY3QgaWQ9IlJlY3RhbmdsZSIgeD0iMzEuNDI2MzA5MiIgeT0iMTUuNTI2MTQ3MiIgd2lkdGg9IjYuMjg1MjYxODQiIGhlaWdodD0iMTguODU1Nzg1NSI+PC9yZWN0PgogICAgICAgICAgICAgICAgICAgICAgICA8cGF0aCBkPSJNNDAuODU0MjAyLDQwLjY2NzE5NDUgTDMuMTQyNjMwOTIsNDAuNjY3MTk0NSBMMy4xNDI2MzA5MiwzNS45NTMyNDgxIEMzLjE0MjYzMDkyLDM1LjA4NTQzNDYgMy44NDYxMzI4MSwzNC4zODE5MzI3IDQuNzEzOTQ2MzgsMzQuMzgxOTMyNyBMMzkuMjgyODg2NSwzNC4zODE5MzI3IEM0MC4xNTA3MDAxLDM0LjM4MTkzMjcgNDAuODU0MjAyLDM1LjA4NTQzNDYgNDAuODU0MjAyLDM1Ljk1MzI0ODEgTDQwLjg1NDIwMiw0MC42NjcxOTQ1IFoiIGlkPSJQYXRoIj48L3BhdGg+CiAgICAgICAgICAgICAgICAgICAgICAgIDxsaW5lIHgxPSIwIiB5MT0iNDYuOTUyNDU2NCIgeDI9IjQzLjk5NjgzMjkiIHkyPSI0Ni45NTI0NTY0IiBpZD0iUGF0aCI+PC9saW5lPgogICAgICAgICAgICAgICAgICAgICAgICA8bGluZSB4MT0iMCIgeTE9IjQwLjY2NzE5NDUiIHgyPSI0My45OTY4MzI5IiB5Mj0iNDAuNjY3MTk0NSIgaWQ9IlBhdGgiPjwvbGluZT4KICAgICAgICAgICAgICAgICAgICAgICAgPHBhdGggZD0iTTQwLjg1NDIwMiw5LjI0MDg4NTMxIEw0MC44NTQyMDIsMTMuOTU0ODMxNyBDNDAuODU0MjAyLDE0LjgyMjY0NTMgNDAuMTUwNzAwMSwxNS41MjYxNDcyIDM5LjI4Mjg4NjUsMTUuNTI2MTQ3MiBMNC43MTM5NDYzOCwxNS41MjYxNDcyIEMzLjg0NjEzMjgxLDE1LjUyNjE0NzIgMy4xNDI2MzA5MiwxNC44MjI2NDUzIDMuMTQyNjMwOTIsMTMuOTU0ODMxNyBMMy4xNDI2MzA5Miw5LjI0MDg4NTMxIEwyMS4yOTY1NjIyLDAuMTY0OTY3MjE1IEMyMS43Mzg2MTUyLC0wLjA1NDk4OTA3MTggMjIuMjU4MjE3NywtMC4wNTQ5ODkwNzE4IDIyLjcwMDI3MDcsMC4xNjQ5NjcyMTUgTDQwLjg1NDIwMiw5LjI0MDg4NTMxIFoiIGlkPSJQYXRoIj48L3BhdGg+CiAgICAgICAgICAgICAgICAgICAgICAgIDxsaW5lIHgxPSIzLjE0MjYzMDkyIiB5MT0iOS4yNDA4ODUzMSIgeDI9IjQwLjg1NDIwMiIgeTI9IjkuMjQwODg1MzEiIGlkPSJQYXRoIj48L2xpbmU+CiAgICAgICAgICAgICAgICAgICAgPC9nPgogICAgICAgICAgICAgICAgPC9nPgogICAgICAgICAgICA8L2c+CiAgICAgICAgPC9nPgogICAgPC9nPgo8L3N2Zz4=",
- "ExternalId": "SJDHGHS",
- "Factsheet": "<root><en /></root>",
- "FactsheetFilesForUpload": [
- {
- "LanguageTwoLetterIsoCode": "fr",
- "FileData": "JVBERi0xLjYKJdP0zOEKNSAwIG9iago8PAovVHlwZS9QYWdlCi9NZWRpYUJveFswIDAgODQxLjg5IDU5NS4yNzZdCi9Hcm91cAo8PAovVHlwZS9Hcm91",
- "FileName": "TestPdf",
- "OldFileExternalId": 0,
- "ToDeleteOldFile": false
}
], - "Currencies": [
- 1,
- 2,
- 3
], - "UpdateProperties": [
- "Name",
- "Description",
- "IsActive",
- "Image",
- "TypeId",
- "CampaignId",
- "ExternalId",
- "Factsheet",
- "FactsheetFilesForUpload",
- "Currencies"
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Retrieves products of a participant
This API is deprecated. Use GET /v1.2/participants/{participantUid}/products instead.
participantId required | integer <int32> The id of the participant. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ParticipantProducts": [
- {
- "Id": 0,
- "ProductId": 0,
- "RoleType": {
- "Key": "Custody",
- "Id": 0,
- "Name": "string"
}, - "Counterparties": [
- {
- "CustodyId": 0,
- "CounterpartyId": 0,
- "Settings": "string"
}
]
}
]
}
Retrieves products of a participant
participantUid required | string <uuid> The uid of the participant. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Products": [
- {
- "Id": 0,
- "RoleType": {
- "Key": "Custody",
- "Id": 0,
- "Name": "string"
}, - "Counterparties": [
- {
- "CounterpartyUid": "string",
- "Settings": "string"
}
]
}
]
}
Returns information on participants associated to the specified product.
productId required | integer <int32> The id of the product. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Participants": [
- {
- "ParticipantUid": "string",
- "RoleType": {
- "Key": "Custody",
- "Id": 0,
- "Name": "string"
}
}
], - "Counterparties": [
- {
- "ParticipantUid": "string",
- "CounterpartyParticipantUid": "string",
- "Settings": "string"
}
]
}
Sets participant association to the specified product
productId required | integer <int32> The id of the product. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Participants required | Array of objects (ParticipantModel) |
Counterparties required | Array of objects (ParticipantCounterpartyModel) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Participants": [
- {
- "ParticipantUid": "string",
- "RoleTypeKey": "Custody"
}
], - "Counterparties": [
- {
- "ParticipantUid": "string",
- "CounterpartyParticipantUid": "string",
- "Settings": "string"
}
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Checks if the specified participant has access to the specified person.
participantUid required | string <uuid> The Uid of the participant. |
personId required | integer <int32> The id of the person. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
true
Gets the details of a product.
productId required | integer <int32> The id of the product |
language required | string The language of the localized resources |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Image": "string",
- "Factsheet": "string",
- "MinimumInvestmentValue": 0,
- "MaximumInvestmentValue": 0,
- "ExternalId": "string",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "Fees": [
- {
- "FeeId": 0,
- "FeeDefinitionId": 0,
- "ValidFrom": "2024-12-18T16:13:44Z",
- "ValidTo": "2024-12-18T16:13:44Z",
- "FeeType": {
- "Id": 0,
- "Name": "string"
}, - "FeeRecurrenceType": {
- "Id": 0,
- "Name": "string"
}, - "IsPercentage": true,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
], - "DefaultOrderBookStatus": {
- "Key": "Reconciliation",
- "Id": 0,
- "Name": "string"
}, - "PortfolioRebalancingType": {
- "Key": "NoRebalancing",
- "Id": 0,
- "Name": "string"
}, - "OptimizationConstraintId": 0,
- "IsActive": true,
- "ProductOfferId": 0,
- "ProductOffer": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Settings": "string",
- "AllowDriftingInvestments": true,
- "AllowDriftingSells": true,
- "AllowRebalancingForTopUp": true,
- "AllowRebalancingForSell": true,
- "ContactType": {
- "UId": "string",
- "Key": "Private",
- "Name": "string"
}
}
Gets all risk categories for a specific product
productId required | integer <int32> |
language required | string |
active | boolean |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Description": "string",
- "Return": 0,
- "ValidYears": 0,
- "RiskCategoryDefinitionId": 0,
- "RiskCategoryId": 0,
- "IsActive": true,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}
}
], - "CurrencyConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}
}
], - "SecuritySectorConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}
}
], - "SecurityConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Security": {
- "Id": 0,
- "Name": "string",
- "Isin": "string",
- "TradingPrice": 0,
- "FaceValue": 0,
- "ExternalId": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "Parent": { },
- "ParentId": 0,
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Type": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "Parent": { },
- "ParentId": 0,
- "Color": "string",
- "IsActive": true,
- "ExternalId": "string",
- "BenchmarkId": 0
}, - "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "BondExtension": {
- "MaturityDate": "2024-12-18T16:13:44Z",
- "BondCouponFrequency": {
- "Key": "Quarterly",
- "Id": 0,
- "Name": "string"
}, - "CouponType": {
- "Key": "Fixed",
- "Id": 0,
- "Name": "string"
}, - "Coupon": 0,
- "InitialSize": 0,
- "IncrementSize": 0,
- "IssueAmount": 0,
- "IssuerType": {
- "Key": "Government",
- "Id": 0,
- "Name": "string"
}, - "IssueDate": "2024-12-18T16:13:44Z"
}, - "OptionExtension": {
- "Strike": 0,
- "IsPut": true,
- "MaturityDate": "2024-12-18T16:13:44Z",
- "OptionExerciseType": {
- "Key": "European",
- "Id": 0,
- "Name": "string"
}
}, - "FutureExtension": {
- "MaturityDate": "2024-12-18T16:13:44Z"
}, - "FundExtension": {
- "SecurityId": 0,
- "InceptionDate": "2024-12-18T16:13:44Z",
- "OfferingFromDate": "2024-12-18T16:13:44Z",
- "OfferingToDate": "2024-12-18T16:13:44Z",
- "Cap": 0,
- "CurrentFill": 0,
- "MinimumInvestmentAmount": 0,
- "MinimumIncrementAmount": 0,
- "FundTypeId": 0,
- "FundManagementTypeId": 0,
- "FundInvestmentTypeId": 0,
- "FundType": {
- "Key": "MutualFund",
- "Id": 0,
- "Name": "string"
}, - "FundManagementType": {
- "Key": "Passive",
- "Id": 0,
- "Name": "string"
}, - "FundInvestmentType": {
- "Key": "OpenEnd",
- "Id": 0,
- "Name": "string"
}
}, - "Ratings": [
- {
- "Id": 0,
- "Value": "string",
- "Color": "string",
- "Agency": {
- "Id": 0,
- "Name": "string",
- "Description": "string"
}
}
], - "Focus": {
- "Id": 0,
- "Name": "string",
- "Parent": { }
}, - "SecurityStockExchanges": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string",
- "RiskFreeRate": 0,
- "SubCurrencyName": "string",
- "SubCurrencyFactor": 0
}, - "Ticker": "string",
- "IsDefault": true,
- "SecurityStockExchangeId": "string",
- "PriceFeedIntegrationIdentifier": "string",
- "PriceFeedIntegrationIdentifierType": "string",
- "StockExchange": {
- "Id": 0,
- "MarketCode": "string",
- "Description": "string",
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
}
], - "IsInvestable": true,
- "IsActive": true,
- "IsShariahCompliant": true,
- "CustomAttributes": "string",
- "TradingUnit": 0,
- "RoundingLot": 0,
- "BenchmarkId": 0,
- "Factor": 0,
- "IsPricePercentage": true,
- "LogoUrl": "string",
- "UId": "string"
}
}
], - "SecurityTypeConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "SecurityType": {
- "Id": 0,
- "Name": "string",
- "Description": "string",
- "Color": "string",
- "ExternalId": "string"
}
}
], - "ContinentConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
], - "EconomicalZoneConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
], - "CountryConstraints": [
- {
- "MinWeight": 0,
- "MaxWeight": 0,
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string",
- "ThreeLetterExternalCode": "string",
- "PhoneCode": "string",
- "Continent": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}
}
}
]
}, - "Id": 0,
- "Name": "string",
- "Min": 0,
- "Max": 0,
- "ExpectedReturn": 0,
- "Color": "string",
- "Attributes": "string",
- "UId": "string"
}
]
Gets the constraints of a product by ID
productId required | integer <int32> The ID of the product to retrieve optimization constraints for |
language required | string The language in which to return all properties |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "OptimizationConstraints": {
- "Id": 0,
- "AssetClassConstraints": [
- {
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "CurrencyConstraints": [
- {
- "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityConstraints": [
- {
- "Security": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "Isin": "string",
- "AssetClass": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Type": {
- "Id": 0,
- "Name": "string"
}, - "Sector": {
- "Id": 0,
- "UId": "string",
- "Name": "string"
}, - "Currency": {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string"
}
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "SecurityTypeConstraints": [
- {
- "SecurityType": {
- "Id": 0,
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "ContinentConstraints": [
- {
- "Continent": {
- "Id": 0,
- "Name": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZone": {
- "Id": 0,
- "Name": "string",
- "Color": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
], - "CountryConstraints": [
- {
- "Country": {
- "Id": 0,
- "UId": "string",
- "CountryCode": "string",
- "Name": "string",
- "ThreeLetterIsoCode": "string"
}, - "MinWeight": 0,
- "MaxWeight": 0
}
]
}
}
Gets the details of an offer. This API is deprecated. Use GET /v1.0/productoffers/{productOfferId} instead.
offerId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "Description": "string",
- "CreateDate": "2024-12-18T16:13:44Z",
- "Picture": "string",
- "IsActive": true,
- "ProductOfferType": {
- "Id": 0,
- "Name": "string"
}, - "ExternalId": "string",
- "UId": "string",
- "Currencies": [
- {
- "Id": 0,
- "UId": "string",
- "Name": "string",
- "CurrencyCode": "string",
- "Symbol": "string"
}
]
}
Searches for product offerings and returns a list with product offering (and key attributes) matching the passed request parameters.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Ids | Array of integers <int32> Nullable |
CreateDateFrom | string <date-time> Nullable |
CreateDateTo | string <date-time> Nullable |
IsActive | boolean Nullable |
ProductOfferTypeIds | Array of integers <int32> Nullable |
ExternalIds | Array of strings Nullable |
UIds | Array of strings <uuid> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "CreateDateFrom": "2024-12-18T16:13:44Z",
- "CreateDateTo": "2024-12-18T16:13:44Z",
- "IsActive": true,
- "ProductOfferTypeIds": [
- 0
], - "ExternalIds": [
- "string"
], - "UIds": [
- "string"
], - "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "ExternalId": "string",
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "CreateDate": "2024-12-18T16:13:44Z",
- "IsActive": true,
- "ProductOfferType": {
- "Id": 0,
- "Name": "string"
}
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Searches for products and returns a list with products (and key attributes) matching the passed request parameters.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Ids | Array of integers <int32> Nullable |
ProductOfferIds | Array of integers <int32> Nullable |
IsActive | boolean Nullable |
ExternalIds | Array of strings Nullable |
UIds | Array of strings <uuid> Nullable |
SortBy | string Nullable |
SortOrder | string (SortOrder) Enum: "Ascending" "Descending" |
Page | integer <int32> |
PageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Ids": [
- 0
], - "ProductOfferIds": [
- 0
], - "IsActive": true,
- "ExternalIds": [
- "string"
], - "UIds": [
- "string"
], - "SortBy": "string",
- "SortOrder": "Ascending",
- "Page": 0,
- "PageSize": 0
}
{- "Results": [
- {
- "Id": 0,
- "ExternalId": "string",
- "UId": "string",
- "Name": "string",
- "Description": "string",
- "MinInvestment": 0,
- "MaxInvestment": 0,
- "ContactType": "string",
- "ProductOfferId": 0,
- "IsActive": true,
- "Image": "string",
- "Factsheet": "string",
- "OptimisationConstraintId": 0,
- "RebalancingType": "string",
- "ProductType": {
- "Id": 0,
- "Name": "string"
}
}
], - "Page": 0,
- "PageSize": 0,
- "PageCount": 0,
- "TotalCount": 0
}
Creates a new product.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
ProductOfferId required | integer <int32> |
Name required | string non-empty |
ContactType required | string (Domain.Abstractions.Enums.ContactType) Enum: "Private" "Corporate" "All" |
IsActive required | boolean |
PortfolioRebalancingType required | string (PortfolioRebalancingTypeId) Enum: "NoRebalancing" "Manual" "Automatic" |
IsBlockOrderBookEnabled required | boolean |
IsOrderBookEnabled required | boolean |
ProductType required | string (ProductTypeId) Enum: "Advisory" "Discretionary" "ExecutionOnly" "Other" "AssistedDiscretionary" |
Settings required | string non-empty |
Description | string Nullable |
Image | string Nullable |
MinimumInvestmentValue | number <double> Nullable |
MaximumInvestmentValue | number <double> Nullable |
ExternalId | string Nullable |
DefaultOrderBookStatus | string (OrderBookStatusId) Enum: "Reconciliation" "ToBeProcessed" "Generated" "Released" "Pulled" "Cancelled" "PartiallyExecuted" "Executed" "Error" "ThresholdBreached" "Undelivered" |
AllowDriftingInvestments | boolean Nullable |
AllowDriftingSells | boolean Nullable |
AllowRebalancingForTopUp | boolean Nullable |
AllowRebalancingForSell | boolean Nullable |
Fees | Array of objects (FeeRequest) Nullable |
OptimizationConstraints | object (OptimizationConstraintRequest) |
InstrumentUniverse | Array of integers <int32> Nullable |
Participants | object (CreateProductParticipantsRequest) |
NationalityCountryUniverse | Array of integers <int32> Nullable |
DomicileCountryUniverse | Array of integers <int32> Nullable |
Factsheet | string Nullable |
FactsheetFilesForUpload | Array of objects (ProductFactsheetFileForUploadRequest) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ProductOfferId": 1,
- "Name": "<root><de>Diskretionärmandat</de><en>Discretionary</en><it>Discrezionale</it><fr>Discrétionnaire</fr></root>",
- "ContactType": "Private",
- "IsActive": true,
- "PortfolioRebalancingType": "NoRebalancing",
- "IsBlockOrderBookEnabled": true,
- "IsOrderBookEnabled": true,
- "ProductType": "Advisory",
- "Settings": "{CustomSettings : [], ThemeTradingSettings: []}",
- "Description": "<root><de>Im 'Descretionary Mandate' delegieren sie alle Investitionsentscheidungen in Verbindung mit diesem Portfolio an ihren Anlageberater. Die Investitionen werden anhand ihres Klienten- und Investitionsprofils ausgeführt. Dieses Angebot hat eine jährliche Gebühr von [Fee] und der minimale Investitionsbetrag beträgt [PlatformCurrency] [Min.Investment].</de><en>Discretionary investment management is ideal for those short on time. Your relationship manager creates a tailored investment strategy based on your goals and risk tolerance. They handle investment decisions without needing your approval for each transaction, while updates to your strategy adapt to your changing needs.</en><it>[IT]In the “Discretionary Mandate” you delegate all investment decisions in connection with this portfolio to the asset manager. Investments are made within the limits of the determined client and investment profile. This offering has a [Fee] annual fee and the minimum investment amount is [PlatformCurrency] [Min.Investment].</it><fr>[FR]In the “Discretionary Mandate” you delegate all investment decisions in connection with this portfolio to the asset manager. Investments are made within the limits of the determined client and investment profile. This offering has a [Fee] annual fee and the minimum investment amount is [PlatformCurrency] [Min.Investment].</fr></root>",
- "Image": "fileInBase64",
- "MinimumInvestmentValue": 25000,
- "MaximumInvestmentValue": 1000000,
- "ExternalId": "SJDHGHS",
- "DefaultOrderBookStatus": "Reconciliation",
- "AllowDriftingInvestments": true,
- "AllowDriftingSells": true,
- "AllowRebalancingForTopUp": true,
- "AllowRebalancingForSell": true,
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": false,
- "ValidFrom": "2024-06-09T00:00:00+00:00",
- "ValidTo": "2024-08-09T00:00:00+00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 4,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 10,
- "ValueTo": 20,
- "FeeValue": 3,
- "InducementValue": 0
}
]
}
], - "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}, - "InstrumentUniverse": [
- 1,
- 2,
- 3,
- 4,
- 5
], - "Participants": {
- "ParticipantsInformation": [
- {
- "ParticipantUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "RoleTypeKey": "Custody"
}
], - "Counterparties": [
- {
- "ParticipantUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "CounterpartyParticipantUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "Settings": "string"
}
]
}, - "NationalityCountryUniverse": [
- 1
], - "DomicileCountryUniverse": [
- 2
], - "Factsheet": "<root><en /></root>",
- "FactsheetFilesForUpload": [
- {
- "LanguageTwoLetterIsoCode": "fr",
- "FileData": "JVBERi0xLjYKJdP0zOEKNSAwIG9iago8PAovVHlwZS9QYWdlCi9NZWRpYUJveFswIDAgODQxLjg5IDU5NS4yNzZdCi9Hcm91cAo8PAovVHlwZS9Hcm91",
- "FileName": "TestPdf",
- "OldFileExternalId": 0,
- "ToDeleteOldFile": false
}
]
}
{- "Id": 0,
- "UId": "string"
}
Creates a new risk category definition for an existing product.
productId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
RiskCategoryId required | integer <int32> |
Description | string Nullable |
Min required | number <double> |
Max required | number <double> |
IsActive | boolean |
ExpectedReturn | number <double> Nullable |
Color | string Nullable |
Attributes | string Nullable |
ValidMonth | integer <int32> Nullable |
OptimizationConstraints | object (OptimizationConstraintRequest) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "RiskCategoryId": 1,
- "Description": "<root><de>TestDescription</de><en>TestDescription</en></root>",
- "Min": 0.05,
- "Max": 0.125,
- "IsActive": true,
- "ExpectedReturn": 0.057,
- "Color": "#000000",
- "Attributes": "{CustomSettings : []}",
- "ValidMonth": 12,
- "OptimizationConstraints": {
- "AssetClassConstraints": [
- {
- "AssetClassId": 3,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CurrencyConstraints": [
- {
- "CurrencyId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecuritySectorConstraints": [
- {
- "SecuritySectorId": 21,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityConstraints": [
- {
- "SecurityId": 94,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "SecurityTypeConstraints": [
- {
- "SecurityTypeId": 2,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "ContinentConstraints": [
- {
- "ContinentId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "EconomicalZoneConstraints": [
- {
- "EconomicalZoneId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
], - "CountryConstraints": [
- {
- "CountryId": 1,
- "MinWeight": 0.25,
- "MaxWeight": 0.75
}
]
}
}
{- "Id": 0
}
Creates a new product offer.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
Name required | string non-empty |
IsActive required | boolean |
TypeId required | integer <int32> |
CampaignId required | integer <int32> |
Description | string Nullable |
Image | string Nullable |
ExternalId | string Nullable |
Factsheet | string Nullable |
FactsheetFilesForUpload | Array of objects (ProductFactsheetFileForUploadRequest) Nullable |
Currencies | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "<root><en>Wealth Offering</en><de>Wealth Offering</de><it>Wealth Offering</it><fr>Wealth Offering</fr></root>",
- "IsActive": true,
- "TypeId": 1,
- "CampaignId": 1,
- "Description": "<root><de /><en>Our Wealth Offering gives you independence and flexibility when managing your finances. You can carry out your banking transactions conveniently, anywhere and at any time. A secure login gets you quickly to all the details of your finances, and provides access to a wide range of functions. Investment decision and discussion are still executed at your local branch with your personal advisor.</en><it /><fr /></root>",
- "Image": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNDZweCIgaGVpZ2h0PSI0OXB4IiB2aWV3Qm94PSIwIDAgNDYgNDkiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayI",
- "ExternalId": "SJDHGHS",
- "Factsheet": "<root><fr>Discrétionnaire</fr></root>",
- "FactsheetFilesForUpload": [
- {
- "LanguageTwoLetterIsoCode": "FR",
- "FileData": "JVBERi0xLjYKJdP0zOEKNSAwIG9iago8PAovVHlwZS9QYWdlCi9NZWRpYUJveFswIDAgODQxLjg5IDU5NS4yNzZdCi9Hcm91cAo8PAovVHlwZS9Hcm91",
- "FileName": "TestPdf",
- "OldFileExternalId": 0,
- "ToDeleteOldFile": false
}
], - "Currencies": [
- 1,
- 2,
- 3
]
}
{- "Id": 0,
- "UId": "string"
}
Updates the products of a participant
participantId required | integer <int32> The id of the participant. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ParticipantProducts | Array of objects (ParticipantProductInfo) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ParticipantProducts": [
- {
- "ProductId": 0,
- "RoleType": "Custody"
}
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Sets the model portfolios available under the provided risk category and product combination.
productId required | integer <int32> |
riskCategoryId required | integer <int32> |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
ModelPortfolios | Array of objects (ModelPortfolioItem) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ModelPortfolios": [
- {
- "Id": 1,
- "SelectionCriteria": "{ABCD}"
}, - {
- "Id": 2,
- "SelectionCriteria": "{ABCDE}"
}
]
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Deletes a partner.
partnerId required | integer <int32> The ID of the partner to delete |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
Gets a Partner details.
partnerId required | integer <int32> The id of the partner. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 0,
- "Name": "string",
- "IsActive": true,
- "Attributes": "string",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2024-12-18T16:13:44Z",
- "ValidTo": "2024-12-18T16:13:44Z",
- "FeeTypeId": 0,
- "FeeRecurrenceTypeId": 0,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
]
}
]
}
The endpoint deletes a referral code if it is not connected to a contact
id required | integer <int32> The id of the referral code to delete |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143537.csv' was already imported on '12/17/2024 2:35:37 PM'."
}
]
}
}
The endpoint returns a referral code by searching for the id of the code
id required | integer <int32> The id of the referralcode. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "Code": "ABCDEF",
- "MaxUsages": 50,
- "CustomAttributes": "",
- "IsActive": true,
- "Partner": {
- "Id": 1,
- "Name": "Partner1"
}, - "CurrentNumberOfUsages": 2
}
The endpoint returns a referral code by searching for the code
code required | string The code of the referralcode. |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Id": 1,
- "Code": "ABCDEF",
- "MaxUsages": 50,
- "CustomAttributes": "",
- "IsActive": true,
- "Partner": {
- "Id": 1,
- "Name": "Partner1"
}, - "CurrentNumberOfUsages": 2
}
The endpoint returns the referral codes of a partner
partnerId required | integer <int32> The id of a partner |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
[- {
- "Id": 1,
- "Code": "ABCDE",
- "MaxUsages": 5,
- "CustomAttributes": "{}",
- "IsActive": true
}, - {
- "Id": 2,
- "Code": "CDG",
- "MaxUsages": 5,
- "CustomAttributes": "{}",
- "IsActive": true
}
]
Modifies a partner.
This API is deprecated.
partnerId required | integer <int32> The ID of the partner to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Name | string Nullable The name of the partner. |
IsActive | boolean This determines whether the partner is active or not. |
Attributes | string Nullable The custom attributes of the partner. |
Fees | Array of objects (FeeRequest) Nullable A set of fees and fees definitions to be associated with the partner. If for a fee the FeeDefinitions node is omitted then only the fee properties will be updated. |
UpdateProperties | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Partner A",
- "IsActive": true,
- "Attributes": "{\"Description\": \"Custom Attributes of Partner modified.\"}",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2018-12-01T00:00:00",
- "ValidTo": "2021-12-31T00:00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 2,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 1.49,
- "FeeValue": 0.02
}, - {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 1.5,
- "ValueTo": 10,
- "FeeValue": 0.01,
- "InducementValue": 0.02
}
]
}
], - "UpdateProperties": [
- "Name",
- "IsActive",
- "Attributes",
- "Fees"
]
}
{- "Id": 0,
- "Name": "string",
- "IsActive": true,
- "Attributes": "string",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2024-12-18T16:13:44Z",
- "ValidTo": "2024-12-18T16:13:44Z",
- "FeeTypeId": 0,
- "FeeRecurrenceTypeId": 0,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
]
}
]
}
The endpoint edits a referral code and the link to a partner
id required | integer <int32> The id of the referral code to modify |
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
Code | string Nullable The referral code |
MaxUsages | integer <int32> Nullable Defines the maximum number of usages for a referral code |
CustomAttributes | string Nullable The custom attributes of a referral code |
IsActive | boolean Nullable This determines whether the referral code is active or not |
PartnerId | integer <int32> Nullable The partner id linked to the referral code |
UpdateProperties | Array of strings Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Code": "123456",
- "MaxUsages": 5,
- "CustomAttributes": "{\"Description\": \"Custom Attributes of the Referral Code.\"}",
- "IsActive": true,
- "PartnerId": 10,
- "UpdateProperties": [
- "Code",
- "MaxUsages",
- "CustomAttributes",
- "IsActive",
- "PartnerId"
]
}
{- "Id": 1,
- "Code": "ABCDEF",
- "MaxUsages": 50,
- "CustomAttributes": "",
- "IsActive": true,
- "Partner": {
- "Id": 1,
- "Name": "Partner1"
}, - "CurrentNumberOfUsages": 2
}
Gets Partner(s) details.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search parameters.
PartnerIds | Array of integers <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "PartnerIds": [
- 1,
- 2
]
}
[- {
- "Id": 0,
- "Name": "string",
- "IsActive": true,
- "Attributes": "string"
}
]
Creates a Partner.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
New partner.
Name | string Nullable The name of the partner. |
IsActive | boolean This determines whether the partner is active or not. |
Attributes | string Nullable The custom attributes of the partner. |
Fees | Array of objects (FeeRequest) Nullable A set of fees and fees definitions to be associated with the partner. |
Created
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "Name": "Partner A",
- "IsActive": false,
- "Attributes": "{\"Description\": \"Custom Attributes of Partner.\"}",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2018-12-01T00:00:00",
- "ValidTo": "2021-12-31T00:00:00",
- "FeeTypeId": 1,
- "FeeRecurrenceTypeId": 2,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 1.49,
- "FeeValue": 0.02
}, - {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 1.5,
- "ValueTo": 10,
- "FeeValue": 0.01,
- "InducementValue": 0.02
}
]
}
]
}
{- "Id": 0,
- "Name": "string",
- "IsActive": true,
- "Attributes": "string",
- "Fees": [
- {
- "Id": 0,
- "IsPercentage": true,
- "ValidFrom": "2024-12-18T16:13:44Z",
- "ValidTo": "2024-12-18T16:13:44Z",
- "FeeTypeId": 0,
- "FeeRecurrenceTypeId": 0,
- "FeeDefinitions": [
- {
- "Id": 0,
- "FeeId": 0,
- "ValueFrom": 0,
- "ValueTo": 0,
- "FeeValue": 0,
- "InducementValue": 0
}
]
}
]
}
This endpoint either generates a number of new referral codes or enters the referral codes to the system as entered in the parameters. Optionally, the referral codes are assigned to a partner. The format of the automatically generated referral codes can be configured on a system level.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
New ReferralCodes
ReferralCodes | Array of strings Nullable Manual entry of one or more referral codes to the system |
PartnerId | integer <int32> Nullable The id of the partner linked to the referral codes |
NumberOfAutoGeneratedReferralCodes | integer <int32> Nullable Defines how many unique referral codes the endpoint will create and store |
MaxUsages required | integer <int32> Defines the maximum number of usages for a referral code. Zero means unlimited usages |
IsActive | boolean Nullable This determines whether the referral code(s) is/are active or not |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReferralCodes": [
- "ABC12345",
- "DEF23456"
], - "PartnerId": 1,
- "NumberOfAutoGeneratedReferralCodes": 5,
- "MaxUsages": 2,
- "IsActive": true
}
{- "ReferralCodes": [
- "ABC12345",
- "DEF23456"
], - "PartnerId": 1,
- "MaxUsages": 2,
- "IsActive": true
}
The endpoint links (assigns) an existing referral code to a contact
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ReferralCodeId | integer <int32> The referral code id |
ContactId | integer <int32> The contact id |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReferralCodeId": 1,
- "ContactId": 20
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143538.csv' was already imported on '12/17/2024 2:35:38 PM'."
}
]
}
}
The endpoint removes the link of a referral code to a contact
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
ReferralCodeId | integer <int32> The referral code id |
ContactId | integer <int32> The contact id |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "ReferralCodeId": 1,
- "ContactId": 20
}
{- "Code": "ValidationFailed",
- "SubCode": "NA",
- "Message": "Validation failed",
- "Properties": {
- "ValidationErrors": [
- {
- "Property": "OriginalFileName",
- "Message": "The file 'Import_Specification_CbsCashTransactions_20241218T143538.csv' was already imported on '12/17/2024 2:35:38 PM'."
}
]
}
}
This endpoint returns the referral codes that are stored in the system.
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The search filter.
SortColumn | string Nullable |
SortOrder | string Nullable |
Search | string Nullable |
ReferralCodeIds | Array of integers <int32> Nullable The ids of the referral codes to be returned. If no id is passed, all referral codes are returned |
PageNumber | integer <int32> The result page number, starting by 1 |
PageSize | integer <int32> The number of items in a result page |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "SortColumn": "Id",
- "SortOrder": "desc",
- "Search": "ABCD",
- "ReferralCodeIds": [
- 1,
- 2
], - "PageNumber": 1,
- "PageSize": 1000
}
{- "ReferralCodes": [
- {
- "Id": 2,
- "Code": "ABCDEF",
- "MaxUsages": 50,
- "CustomAttributes": "",
- "IsActive": true,
- "Partner": {
- "Id": 1,
- "Name": "Partner1"
}, - "CurrentNumberOfUsages": 49
}, - {
- "Id": 3,
- "Code": "ABCDEF",
- "MaxUsages": 50,
- "CustomAttributes": "",
- "IsActive": true,
- "Partner": {
- "Id": 2,
- "Name": "Partner2"
}, - "CurrentNumberOfUsages": 1
}
], - "TotalNumberOfResults": 2
}