Loading
Documentation Powered by ReDoc

DFS Service Layer API (latest)

Download OpenAPI specification:Download

Accounts

Retrieve a specific account

Retrieve a specific account (active or inactive).

Authorizations:
Bearer
path Parameters
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.

query Parameters
language
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/contacts/{contactId}/accounts/{accountId}
https://example-host/v1.1/contacts/{contactId}/accounts/{accountId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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":
    {
    },
  • "ContactGroupId": 5,
  • "Type":
    {
    },
  • "IsActive": true,
  • "OpeningDate": "2022-05-24T06:59:49.3984267+00:00",
  • "ProductId": 3,
  • "Status":
    {
    },
  • "ClosingDate": "2023-11-24T06:59:49.3984319+00:00",
  • "IntegrationStatus":
    {
    },
  • "Attributes": "{\"Description\": \"This the Account the Client always wanted to have!\"}",
  • "SubAccounts": [ ],
  • "AvailableBalance": 3000,
  • "AvailableBalanceLastUpdateDate": "2022-08-18T00:00:00"
}

Modify account

Modifies an existing account.

Authorizations:
Bearer
path Parameters
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

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.1/contacts/{contactId}/accounts/{accountId}
https://example-host/v1.1/contacts/{contactId}/accounts/{accountId}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "AccountNumber": "string",
  • "Iban": "string",
  • "InternalId": "string",
  • "Name": "string",
  • "BranchId": 0,
  • "AccountType": 0,
  • "Balance": 0,
  • "BalanceDate": "2023-05-24T07:09:17Z",
  • "IsActive": true,
  • "ParentId": 0,
  • "Product": 0,
  • "Status": 0,
  • "OpeningDate": "2023-05-24T07:09:17Z",
  • "ClosingDate": "2023-05-24T07:09:17Z",
  • "IntegrationStatus": 0,
  • "CustomAttributes": "string",
  • "ContactGroupId": 0,
  • "AvailableBalance": 0,
  • "AvailableBalanceLastUpdateDate": "2023-05-24T07:09:17Z",
  • "UpdateProperties":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Retrieve all accounts of a contact

Retrieve all accounts of a contact (active or inactive).

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The contactId of the contact

query Parameters
language
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/contacts/{contactId}/accounts
https://example-host/v1.1/contacts/{contactId}/accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Modify account Deprecated

Modifies an existing account.
This API is deprecated. Use PATCH /v1.1/contacts/{contactId}/accounts/{accountId} instead.

Authorizations:
Bearer
path Parameters
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

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The parameter DTO

AccountNumber
string Nullable

The optional new account number of the account.

Iban
object (UpdateProperty%3C%3E)
InternalId
object (UpdateProperty%3C%3E)
Name
object (UpdateProperty%3C%3E)
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
object (Legacy.UpdateProperty%3CSystem.Nullable%3CDecimal%3E%3E)
BalanceDate
object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E)
IsActive
boolean Nullable

This determines whether the Account is active or not.

ParentId
object (Legacy.UpdateProperty%3CSystem.Nullable%3CInt32%3E%3E)
Product
object (Legacy.UpdateProperty%3CSystem.Nullable%3CInt32%3E%3E)
Status
integer <int32> Nullable

The optional new status of the account.

OpeningDate
object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E)
ClosingDate
object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E)
IntegrationStatus
object (Legacy.UpdateProperty%3CSystem.Nullable%3CInt16%3E%3E)
CustomAttributes
object (UpdateProperty%3C%3E)
ContactGroupId
object (Legacy.UpdateProperty%3CInt32%3E)
AvailableBalance
object (Legacy.UpdateProperty%3CSystem.Nullable%3CDecimal%3E%3E)
AvailableBalanceLastUpdateDate
object (Legacy.UpdateProperty%3CSystem.Nullable%3CDateTime%3E%3E)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/contacts/{contactId}/accounts/{accountId}
https://example-host/v1.0/contacts/{contactId}/accounts/{accountId}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "AccountNumber": "002500078712000099999",
  • "Iban":
    {
    },
  • "InternalId":
    {
    },
  • "Name":
    {
    },
  • "BranchId": 4,
  • "AccountType": 5,
  • "Balance":
    {
    },
  • "BalanceDate":
    {
    },
  • "IsActive": true,
  • "ParentId":
    {
    },
  • "Product":
    {
    },
  • "Status": 1,
  • "OpeningDate":
    {
    },
  • "ClosingDate":
    {
    },
  • "IntegrationStatus":
    {
    },
  • "CustomAttributes":
    {
    },
  • "AvailableBalance":
    {
    },
  • "AvailableBalanceLastUpdateDate":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create a new Account

Creates a new account.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The ID of the contact for the new account

query Parameters
language
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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
integer <int32> Nullable

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/contacts/{contactId}/accounts/create
https://example-host/v1.0/contacts/{contactId}/accounts/create

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "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": "2023-05-24T06:59:49.6130063+00:00"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ContactId": 1,
  • "Account":
    {
    }
}

Allows the User to search for Accounts of an authenticated Contact for a given set of criteria

Allows the User to search for Accounts of an authenticated Contact for a given set of criteria

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The contactId of the contact

query Parameters
language
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/contacts/{contactId}/accounts/search
https://example-host/v1.1/contacts/{contactId}/accounts/search

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "BranchIds":
    [
    ],
  • "CurrencyIds":
    [
    ],
  • "ContactGroupIds":
    [
    ],
  • "AccountTypes":
    [
    ],
  • "IsActive": true,
  • "ProductIds":
    [
    ],
  • "AccountStatuses":
    [
    ],
  • "Page": 1,
  • "PageSize": 10
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Results":
    [
    ],
  • "Page": 1,
  • "PageSize": 10,
  • "PageCount": 1,
  • "TotalCount": 2
}

Search accounts

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.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/accounts/search
https://example-host/v1.0/accounts/search

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "AccountNumber": "string",
  • "Iban": "string",
  • "InternalId": "string",
  • "Name": "string",
  • "Ids":
    [
    ],
  • "BranchIds":
    [
    ],
  • "BankIds":
    [
    ],
  • "CurrencyIds":
    [
    ],
  • "ContactIds":
    [
    ],
  • "ContactGroupIds":
    [
    ],
  • "AccountTypeIds":
    [
    ],
  • "IsActive": true,
  • "ParentIds":
    [
    ],
  • "ProductIds":
    [
    ],
  • "AccountStatusIds":
    [
    ],
  • "BalanceUpdateDateFrom": "2023-05-24T07:09:17Z",
  • "BalanceUpdateDateTo": "2023-05-24T07:09:17Z",
  • "OpeningDateFrom": "2023-05-24T07:09:17Z",
  • "OpeningDateTo": "2023-05-24T07:09:17Z",
  • "ClosingDateFrom": "2023-05-24T07:09:17Z",
  • "ClosingDateTo": "2023-05-24T07:09:17Z",
  • "SortBy": "string",
  • "SortOrder": "Ascending",
  • "Page": 0,
  • "PageSize": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Results":
    [
    ],
  • "Page": 0,
  • "PageSize": 0,
  • "PageCount": 0,
  • "TotalCount": 0
}

Bank

Delete bank

Delete bank

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing bank

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/banks/{id}
https://example-host/v1.0/banks/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get bank

Return a bank by id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Bank id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/banks/{id}
https://example-host/v1.0/banks/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "Europe bank",
  • "Bic": "BARCGB22XXX",
  • "Code": "x9x9x9x"
}

Update bank

Update existing bank

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing bank

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the bank to update

Name
string Nullable
Bic
string Nullable
Code
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/banks/{id}
https://example-host/v1.0/banks/{id}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "string",
  • "Bic": "string",
  • "Code": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "Europe bank",
  • "Bic": "BARCGB22XXX",
  • "Code": "x9x9x9x"
}

Delete bank account type

Deletes bank account type

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing bank account type

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/bankaccounttypes/{id}
https://example-host/v1.0/bankaccounttypes/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get bank account type

Returns a bank account type by id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Bank account type id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/bankaccounttypes/{id}
https://example-host/v1.0/bankaccounttypes/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "Cash",
  • "InternalId": "Cash",
  • "Description": "Cash account type"
}

Update bank account type

Updates existing bank account type

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing bank account type

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the bank account type to update

Name
string Nullable
InternalId
string Nullable
Description
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/bankaccounttypes/{id}
https://example-host/v1.0/bankaccounttypes/{id}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "Cash",
  • "InternalId": "Cash",
  • "Description": "Cash account type"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "Cash",
  • "InternalId": "Cash",
  • "Description": "Cash account type"
}

Delete bank branch

Delete bank branch from the system.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing bank branch

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/bankbranches/{id}
https://example-host/v1.0/bankbranches/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get bank list

Returns the list of all banks in the system.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/banks
https://example-host/v1.0/banks

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create bank

Create a new bank

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the bank to create

Name
string Nullable
Bic
string Nullable
Code
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/banks
https://example-host/v1.0/banks

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "string",
  • "Bic": "string",
  • "Code": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "Europe bank",
  • "Bic": "BARCGB22XXX",
  • "Code": "x9x9x9x"
}

Get bank account type list

Returns the list of all bank account types in the system.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/bankaccounttypes
https://example-host/v1.0/bankaccounttypes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create bank account type

Creates a new bank account type

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the bank account type to create

Name
string Nullable
InternalId
string Nullable
Description
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/bankaccounttypes
https://example-host/v1.0/bankaccounttypes

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "Cash",
  • "InternalId": "Cash",
  • "Description": "Cash account type"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "Cash",
  • "InternalId": "Cash",
  • "Description": "Cash account type"
}

Get bank branch by id

Returns bank branch by its id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the bank branch

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/bankbranches/{id}
https://example-host/v1.1/bankbranches/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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 bank branch

Update existing bank branch.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing bank branch

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.1/bankbranches/{id}
https://example-host/v1.1/bankbranches/{id}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "Branch 1",
  • "BankId": 1,
  • "CountryId": 2,
  • "Code": "227",
  • "AddressLine1": "Rue des Avenges",
  • "AddressLine2": "25",
  • "AddressLine3": "6356",
  • "AddressLine4": "Andorra",
  • "Bic": "AD63746",
  • "PhoneNumber": "+32|33356989"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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"
}

Get bank branch list

Returns the list of all bank branches in the system.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.1/bankbranches
https://example-host/v1.1/bankbranches

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create bank branch

Create a new bank branch in the system.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/bankbranches
https://example-host/v1.1/bankbranches

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "Branch 1",
  • "BankId": 1,
  • "CountryId": 2,
  • "Code": "227",
  • "AddressLine1": "Rue des Avenges",
  • "AddressLine2": "25",
  • "AddressLine3": "6356",
  • "AddressLine4": "Andorra",
  • "Bic": "AD63746",
  • "PhoneNumber": "+32|33356989"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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"
}

Common

Delete risk category

Deletes a risk category.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The Id of the risk category

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/riskcategories/{id}
https://example-host/v1.0/riskcategories/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Delete economical zone

Delete economical zone

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing economical zone

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/economicalzones/{id}
https://example-host/v1.0/economicalzones/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get economical zone Deprecated

Return a economical zone by id.
This API is deprecated. Use GET /v1.1/economicalzones/{id} instead

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Economical zone id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/economicalzones/{id}
https://example-host/v1.0/economicalzones/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "<root><de>Europe zone</de><en>Europe zone</en><fr>Europe zone</fr><ja>Europe zone</ja><ru>Europe zone</ru></root>",
  • "Color": "#56d96f"
}

Update economical zone Deprecated

Update existing economical zone.
This API is deprecated. Use PUT /v1.1/economicalzones/{id} instead

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing economical zone

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the economical zone to update

Name
required
Array of objects (LocalizedValue)
Color
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/economicalzones/{id}
https://example-host/v1.0/economicalzones/{id}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name":
    [
    ],
  • "Color": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "<root><de>Europe zone</de><en>Europe zone</en><fr>Europe zone</fr><ja>Europe zone</ja><ru>Europe zone</ru></root>",
  • "Color": "#56d96f"
}

Delete rating agency

Deletes a rating agency.

Authorizations:
Bearer
path Parameters
ratingAgencyId
required
integer <int32>

Rating agency Id to be deleted

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/ratingagencies/{ratingAgencyId}
https://example-host/v1.0/ratingagencies/{ratingAgencyId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get rating agency

Returns a rating agency by its id.

Authorizations:
Bearer
path Parameters
ratingAgencyId
required
integer <int32>

Rating agency Id

query Parameters
language
string

Language to translate the resource. If null, returns xml for all languages

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/ratingagencies/{ratingAgencyId}
https://example-host/v1.0/ratingagencies/{ratingAgencyId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "Description": "string"
}

Update rating agency Deprecated

Updates an existing rating agency.
This API is deprecated. Use PATCH /v1.1/ratingagencies/{ratingAgencyId} instead

Authorizations:
Bearer
path Parameters
ratingAgencyId
required
integer <int32>

Rating agency Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Request data

Name
object (UpdateProperty%3C%3E)
Description
object (UpdateProperty%3C%3E)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/ratingagencies/{ratingAgencyId}
https://example-host/v1.0/ratingagencies/{ratingAgencyId}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name":
    {
    },
  • "Description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Delete rating

Deletes a rating.

Authorizations:
Bearer
path Parameters
ratingAgencyId
required
integer <int32>

Rating agency Id

ratingId
required
integer <int32>

Rating Id to be deleted

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/ratingagencies/{ratingAgencyId}/ratings/{ratingId}
https://example-host/v1.0/ratingagencies/{ratingAgencyId}/ratings/{ratingId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get rating for rating agency

Returns a rating by its id.

Authorizations:
Bearer
path Parameters
ratingAgencyId
required
integer <int32>

Rating agency Id

ratingId
required
integer <int32>

Rating Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/ratingagencies/{ratingAgencyId}/ratings/{ratingId}
https://example-host/v1.0/ratingagencies/{ratingAgencyId}/ratings/{ratingId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Rating":
    {
    },
  • "RatingAgency":
    {
    }
}

Update rating Deprecated

Updates an existing rating.
This API is deprecated. Use PATCH /v1.1/ratingagencies/{ratingAgencyId}/ratings/{ratingId} instead.

Authorizations:
Bearer
path Parameters
ratingAgencyId
required
integer <int32>

Rating agency Id

ratingId
required
integer <int32>

Rating Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Request data

Value
object (UpdateProperty%3C%3E)
Color
object (UpdateProperty%3C%3E)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/ratingagencies/{ratingAgencyId}/ratings/{ratingId}
https://example-host/v1.0/ratingagencies/{ratingAgencyId}/ratings/{ratingId}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Value":
    {
    },
  • "Color":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Health check

Performs a health check of the system. Will return "OK" as "text/plain" if everything is working properly.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/health-check
https://example-host/v1.0/health-check

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get system settings

Returns system settings. If the optional group parameter is passed only settings for this group will be returned, otherwise all available settings.

Authorizations:
Bearer
query Parameters
group
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/settings
https://example-host/v1.0/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get system setting

Returns a specific system setting. The name of the group and the name of the key need to be supplied.

Authorizations:
Bearer
path Parameters
group
required
string
key
required
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/settings/{group}/{key}
https://example-host/v1.0/settings/{group}/{key}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Key": "string",
  • "Value": "string",
  • "Group": "string"
}

Get current campaign configuration

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).

Authorizations:
Bearer
query Parameters
language
required
string
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.2/campaigns/current/configuration
https://example-host/v1.2/campaigns/current/configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ProductOffers":
    [
    ],
  • "Languages":
    [
    ],
  • "DefaultLanguage":
    {
    },
  • "DefaultTimeZoneUtcOffsetMinutes": 0
}

Get product by id

Gets the details of a product.

Authorizations:
Bearer
path Parameters
productId
required
integer <int32>

The id of the product

query Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/products/{productId}
https://example-host/v1.0/products/{productId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "UId": "string",
  • "Name": "string",
  • "Description": "string",
  • "Image": "string",
  • "Factsheet": "string",
  • "MinimumInvestmentValue": 0,
  • "MaximumInvestmentValue": 0,
  • "ExternalId": "string",
  • "IsBlockOrderBookEnabled": true,
  • "IsOrderBookEnabled": true,
  • "Fees":
    [
    ],
  • "DefaultOrderBookStatus":
    {
    },
  • "PortfolioRebalancingType":
    {
    },
  • "OptimizationConstraintId": 0,
  • "IsActive": true,
  • "ProductOfferId": 0,
  • "ProductOffer":
    {
    },
  • "Settings": "string"
}

Get country list

Returns the list of all countries in the system.

Authorizations:
Bearer
path Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/countries/{language}
https://example-host/v1.0/countries/{language}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get language list

Returns the list of all languages in the system.

Authorizations:
Bearer
path Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/languages/{language}
https://example-host/v1.0/languages/{language}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get datasources

Returns a list of all available data sources.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

get/v1.0/datasources/all
https://example-host/v1.0/datasources/all

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get stored procedure names

Returns a list of stored procedures available for the provided data source and schema

Authorizations:
Bearer
path Parameters
dataSourceName
required
string

Name of the data source

schema
required
string

Name of the specific DB schema

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/datasources/{dataSourceName}/storedprocedures/{schema}
https://example-host/v1.0/datasources/{dataSourceName}/storedprocedures/{schema}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get risk categories

Gets all risk categories for a specific product

Authorizations:
Bearer
path Parameters
productId
required
integer <int32>
query Parameters
language
required
string
active
boolean
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/products/{productId}/riskcategories
https://example-host/v1.1/products/{productId}/riskcategories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get risk categories

Returns the list of all risk categories.

Authorizations:
Bearer
query Parameters
language
required
string

The language in which to return all properties

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/riskcategories
https://example-host/v1.1/riskcategories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create risk category

Creates a risk category.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The parameter DTO.

Name
Array of objects (LocalizedValue) Nullable

The Name of the risk category

ExternalId
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/riskcategories
https://example-host/v1.1/riskcategories

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name":
    [
    ],
  • "ExternalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0
}

Get risk category Deprecated

This API is deprecated. Use GET /v1.2/riskcategories/{id} instead

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The id of the risk category.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/riskcategories/{id}
https://example-host/v1.1/riskcategories/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "ExternalId": "string"
}

Update risk category

Updates a risk category.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The id of the risk category.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

The parameter DTO.

Name
Array of objects (LocalizedValue) Nullable

The Name of the risk category

ExternalId
string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.1/riskcategories/{id}
https://example-host/v1.1/riskcategories/{id}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name":
    [
    ],
  • "ExternalId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Code": "BadRequest",
  • "SubCode": "NA",
  • "Message": "The request was not in the required format",
  • "CorrelationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get risk category

Returns a risk cateogry by its id.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

The id of the risk category.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.2/riskcategories/{id}
https://example-host/v1.2/riskcategories/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "ExternalId": "string"
}

Get product constraints

Gets the constraints of a product by ID

Authorizations:
Bearer
path Parameters
productId
required
integer <int32>

The ID of the product to retrieve optimization constraints for

query Parameters
language
required
string

The language in which to return all properties

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v3.0/products/{productId}/optimizationconstraints
https://example-host/v3.0/products/{productId}/optimizationconstraints

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "OptimizationConstraints":
    {
    }
}

Get assetclass tree

Returns the tree of all assetclasses in the system.

Authorizations:
Bearer
path Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/assetclasses/{language}
https://example-host/v1.0/assetclasses/{language}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get continent list

Returns the list of all continents in the system.

Authorizations:
Bearer
path Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/continents/{language}
https://example-host/v1.0/continents/{language}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get securitytype list

Returns the list of all securitytypes in the system.

Authorizations:
Bearer
path Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/securitytypes/{language}
https://example-host/v1.0/securitytypes/{language}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get security sector tree

Returns the tree of all security sectors in the system.

Authorizations:
Bearer
path Parameters
language
required
string

The language of the localized resources

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/sectors/{language}
https://example-host/v1.0/sectors/{language}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get economical zones list

Returns the list of all economical zones in the system.

Authorizations:
Bearer
query Parameters
language
required
string

Language value for xml fields

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/economicalzones
https://example-host/v1.0/economicalzones

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create economical zone Deprecated

Create a new economical zone.
This API is deprecated. Use POST /v1.1/economicalzones instead

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the economical zone to create

Name
required
Array of objects (LocalizedValue)
Color
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/economicalzones
https://example-host/v1.0/economicalzones

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name":
    [
    ],
  • "Color": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 1,
  • "Name": "<root><de>Europe zone</de><en>Europe zone</en><fr>Europe zone</fr><ja>Europe zone</ja><ru>Europe zone</ru></root>",
  • "Color": "#56d96f"
}

Get economical zone

Return a economical zone by id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Economical zone id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.1/economicalzones/{id}
https://example-host/v1.1/economicalzones/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Id": 0,
  • "Name": "string",
  • "Color": "string"
}

Update economical zone

Update existing economical zone

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the existing economical zone

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json-patch+json

Properties of the economical zone to update

Name
required
string non-empty
Color
string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.1/economicalzones/{id}
https://example-host/v1.1/economicalzones/{id}

Request samples

Content type
application/json-patch+json
Copy
 Expand all Collapse all
{
  • "Name": "string",
  • "Color": "string"
}

Response samples

Content type
application/json